OpenZeppelin / cairo-contracts

OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
https://docs.openzeppelin.com/contracts-cairo
MIT License
813 stars 329 forks source link

Update README.md #915

Closed medbukadnezoor closed 7 months ago

medbukadnezoor commented 7 months ago

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