Skip to content

Commit

Permalink
docs: Recommend rustlings watch as default
Browse files Browse the repository at this point in the history
  • Loading branch information
komaeda committed Jun 9, 2019
1 parent 75d8c7e commit 635e506
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ curl -L https://git.io/rustlings | bash -s mypath/

This will install Rustlings and give you access to the `rustlings` command. Run it to get started!

## Windows/Manually
## Manually

Basically: Clone the repository, checkout to the latest tag, run `cargo install`.

Expand All @@ -51,16 +51,16 @@ The exercises are sorted by topic and can be found in the subdirectory `rustling
The task is simple. Most exercises contain an error that keep it from compiling, and it's up to you to fix it! Some exercises are also ran as tests, but rustlings handles them all the same. To run the exercises in the recommended order, execute:

```bash
rustlings verify
rustlings watch
```

This will try to verify the completion of every exercise in a predetermined order (what we think is best for newcomers). If you don't want to rerun `verify` every time you change a file, you can run:
This will try to verify the completion of every exercise in a predetermined order (what we think is best for newcomers). It will also rerun automatically every time you change a file in the `exercises/` directory. If you want to only run it once, you can use:

```bash
rustlings watch
rustlings verify
```

This will do the same as verify, but won't quit after running and instead automatically rerun as soon as you change a file in the `exercises/` directory.
This will do the same as watch, but it'll quit after running.

In case you want to go by your own order, or want to only verify a single exercise, you can run:

Expand Down
2 changes: 1 addition & 1 deletion default_out.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ cargo install --path .
If you've done all of this (or even most of it), congrats! You're ready
to start working with Rust.

To get started, run `rustlings verify` in order to get the first exercise.
To get started, run `rustlings watch` in order to get the first exercise.
Make sure to have your editor open!

0 comments on commit 635e506

Please sign in to comment.