Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme and installation docs #2725

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Conversation

cptartur
Copy link
Member

Closes #1712
Closes #2690

Introduced changes

  • Updated installation instructions in readme and docs
  • Updated GIF in docs
  • Removed "Features" section as it duplicates "Roadmap"

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

@cptartur cptartur marked this pull request as ready for review November 27, 2024 16:46
Copy link
Collaborator

@franciszekjob franciszekjob left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you verify the guides from start to end by following the instructions on each platform?

Comment on lines +51 to +55
#### Install ASDF

Follow the instructions from [asdf docs](https://asdf-vm.com/guide/getting-started.html#getting-started).

To verify that ASDF was correctly installed, run
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applies to other occurrences

Suggested change
#### Install ASDF
Follow the instructions from [asdf docs](https://asdf-vm.com/guide/getting-started.html#getting-started).
To verify that ASDF was correctly installed, run
#### Install asdf
Follow the instructions from [asdf docs](https://asdf-vm.com/guide/getting-started.html#getting-started).
To verify that asdf was correctly installed, run

To install Starknet Foundry, first install `snfoundryup` by running:
### Linux and MacOS

#### Install Rust >= 1.80.1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would explain why we even do this here (under the whole installation step perhaps?)

```

Follow the instructions and then run
To verify that Scarb was correctly installed, run
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is it verifying the correctness of installation?

```

Follow the instructions and then run:
##### Common Error
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I lack other examples here, namely ones with rust <1.84

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prioritize asdf installation over using the script Update README.md
3 participants