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.md #915

Closed
wants to merge 1 commit into from
Closed

Conversation

medbukadnezoor
Copy link

Incorrect or unclear instructions:

The document mentions "Simply install Cairo and scarb." However, the link provided does not directly lead to installation instructions for both Cairo and scarb, but likely only to one. Edited to provide links for both.

"scarb" is sometimes capitalized and other times not. For consistency, it should be treated the same throughout the document.

edited one instance of scarb.toml to Scarb.toml

Command consistency:

Usage of $ before some commands and not others can confuse readers about whether to include it in the terminal. It's standard in documentation to use $ to represent the command prompt, but it should be consistently used or omitted.

Fixes #???

PR Checklist

  • Tests
  • Documentation
  • Added entry to CHANGELOG.md
  • Tried the feature on a public network

Incorrect or unclear instructions:

The document mentions "Simply install Cairo and scarb." However, the link provided does not directly lead to installation instructions for both Cairo and scarb, but likely only to one. Edited to provide links for both.

"scarb" is sometimes capitalized and other times not. For consistency, it should be treated the same throughout the document.

edited one instance of scarb.toml to Scarb.toml

Command consistency:

Usage of $ before some commands and not others can confuse readers about whether to include it in the terminal. It's standard in documentation to use $ to represent the command prompt, but it should be consistently used or omitted.
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.

1 participant