Update readme and installation docs #2725
Open
+142
−102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cptartur
requested review from
ddoktorski,
kkawula and
franciszekjob
as code owners
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 |
There was a problem hiding this comment.
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 |
Arcticae
requested changes
Nov 27, 2024
| To install Starknet Foundry, first install `snfoundryup` by running: | ||
| ### Linux and MacOS | ||
|
|
||
| #### Install Rust >= 1.80.1 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
How is it verifying the correctness of installation?
| ``` | ||
|
|
||
| Follow the instructions and then run: | ||
| ##### Common Error |
There was a problem hiding this comment.
I lack other examples here, namely ones with rust <1.84
ddoktorski
reviewed
Nov 29, 2024
| @@ -74,7 +171,7 @@ Starknet Foundry is under active development! Expect a lot of new features to ap | |||
| - [x] Deployment scripts written in Cairo | |||
| - [ ] Transactions profiling 🏗️ | |||
| - [ ] Debugging utilities 🏗️ | |||
| - [ ] Test coverage reports (check out [cairo-coverage](https://github.com/software-mansion/cairo-coverage)) 🏗️ | |||
| - [ ] Test coverage reports (check out [cairo-coverage](https://github.com/software-mansion/cairo-coverage)) 🏗️ | |||
There was a problem hiding this comment.
Maybe let's add a point about parameterized tests to the roadmap?
|
|
||
| ```shell | ||
| $ snfoundryup | ||
| No version is set for command snforge | ||
| Consider adding one of the following versions in your config file at starknet-foundry 0.32.0 |
There was a problem hiding this comment.
Suggested change
| Consider adding one of the following versions in your config file at starknet-foundry 0.32.0 | |
| Consider adding one of the following versions in your config file at $HOME/.tool_versions | |
| starknet-foundry 0.32.0 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1712
Closes #2690
Introduced changes
Checklist
CHANGELOG.md