summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorliv <liv@fastmail.com>2019-01-09 21:02:47 +0100
committerliv <liv@fastmail.com>2019-01-09 21:02:47 +0100
commit7907dedda664810b3d6087d13ffc505f6cb87159 (patch)
tree1b3790e9660d5df241f2b26777b3a431eeb80471 /README.md
parent6fb82fd63472f7acd91f185204eb6f96d56c4b31 (diff)
clean up readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 14 insertions, 19 deletions
diff --git a/README.md b/README.md
index 2c86cfd..76ced0e 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,37 @@
# rustlings
-Greetings and welcome to rustlings. This project contains small exercises to get you used to reading and writing code. This includes reading and responding to compiler messages!
+Greetings and welcome to `rustlings`. This project contains small exercises to get you used to reading and writing Rust code. This includes reading and responding to compiler messages!
-## How to get started
+Alternatively, for a first-time Rust learner, there's several other resources:
-To use rustlings you need to have a [Rust](https://www.rust-lang.org/) toolchain installed. To install it go to [rustup.rs](https://rustup.rs/).
+- [The Book](https://doc.rust-lang.org/book/index.html) - The most comprehensive resource for learning Rust, but a bit theoretical sometimes
+- [Rust By Example](https://doc.rust-lang.org/rust-by-example/index.html) - Learn Rust by solving little exercises! It's almost like `rustlings`, but online
-Once Rust is installed, clone the rustlings repository and enter the resulting directory:
+## Getting Started
+
+To use `rustlings` you need to have [Rust](https://www.rust-lang.org/) installed on your computer. To install Rust, go to [rustup.rs](https://rustup.rs/).
+
+Once Rust is installed, clone the `rustlings` repository and enter the resulting directory:
```bash
git clone https://github.com/rustlings/rustlings.git
cd rustlings
```
-Once in the directory you can install rustlings on your machine and run exercises:
+Once in the directory you can install `rustlings` on your machine and run the introduction:
```bash
cargo install --path .
-rustlings <command>
-```
-
-Or run rustlings directly with cargo, without installing it:
-
-```bash
-cargo run <command>
+rustlings
```
-If you choose to not install rustlings, just replace `rustlings` with `cargo run` in the rest of this text.
+If you choose to not install the `rustlings` command, just replace `rustlings` with `cargo run` in the rest of this text.
## Doing exercises
-The exercises are sorted by topic and can be found in the subdirectory `rustlings/exercises/<topic>`. For every topic there is an additional README file with some resources to get you started on the topic. We really recommend, that you have a look at them before you start.
-
-For every topic there is an additional README file with some resources to get you started on the topic. We really recommend, that you have a look at them before you start.
-
-Your task is simple. Every exercise contains an error you have to solve, in order to make it compile.
+The exercises are sorted by topic and can be found in the subdirectory `rustlings/exercises/<topic>`. For every topic there is an additional README file with some resources to get you started on the topic. We really recommend that you have a look at them before you start.
-Running `rustlings verify` will compile every exercise in the recommended order. It will stop at the first exercise that didn't compile and show you the error to be solved.
+Your task is simple. Every exercise contains an error you have to solve in order to make it compile. Running `rustlings verify` will compile every exercise in the recommended order. It will stop at the first exercise that didn't compile and show you the error to be solved.
`rustlings watch` will rerun this verification every time you save an exercise.