Skip to content

Commit

Permalink
fix: grammatical errors and rephrase README.md
Browse files Browse the repository at this point in the history
Signed-off-by: ImmuneFOMO <[email protected]>
  • Loading branch information
ImmuneFOMO authored Dec 20, 2023
1 parent 8d75c10 commit 15c1f27
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ The following are **minimum** requirements to run an Aleo node:
- Provers: CUDA-enabled GPU (optional)
- Validators: Not required at this time

Please note to run an Aleo Prover that is **competitive**, the machine will require more than these requirements.
Just so you know, to run an Aleo Prover that is **competitive**, the machine will need more than these requirements.

### 2.2 Installation

Before beginning, please ensure your machine has `Rust v1.66+` installed. Instructions to [install Rust can be found here.](https://www.rust-lang.org/tools/install)

Start by cloning this Github repository:
Start by cloning this GitHub repository:
```
git clone https://github.com/AleoHQ/snarkOS.git --depth 1
```
Expand Down Expand Up @@ -150,11 +150,11 @@ APrivateKey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
### 3. I can't generate a new address ###

- Before running the command above (`snarkos account new`) try `source ~/.bashrc`
- Also double-check the spelling of `snarkos`. Note the directory is `/snarkOS`, the command is `snarkos`
- Also double-check the spelling of `snarkos`. Note the directory is `/snarkOS`, and the command is `snarkos`

## 5. Command Line Interface

To run a node with custom settings, refer to the full list of options and flags available in the `snarkOS` CLI.
To run a node with custom settings, refer to the options and flags available in the `snarkOS` CLI.

The full list of CLI flags and options can be viewed with `snarkos --help`:
```
Expand Down Expand Up @@ -225,7 +225,7 @@ In the fourth terminal, start the fourth validator by running:
cargo run --release -- start --nodisplay --dev 3 --validator
```

From here, this procedure can be used to further start up provers and clients.
From here, this procedure can be used to further start-up provers and clients.

### 6.2 Operations

Expand Down Expand Up @@ -434,7 +434,7 @@ Thank you for helping make snarkOS better!

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

## 8. License

Expand Down

0 comments on commit 15c1f27

Please sign in to comment.