rustlings/README.md

51 lines
2.5 KiB
Markdown
Raw Normal View History

2019-01-09 14:13:39 -06:00
![crab pet](http://i.imgur.com/LbZJgmm.gif)
2019-01-09 14:17:02 -06:00
# rustlings 🦀❤️
2015-09-14 21:32:54 -05:00
2019-01-09 14:02:47 -06:00
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!
2019-01-09 14:02:47 -06:00
Alternatively, for a first-time Rust learner, there's several other resources:
2019-01-09 14:02:47 -06:00
- [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
2019-01-09 14:02:47 -06:00
## 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
```
2019-01-09 14:02:47 -06:00
Once in the directory you can install `rustlings` on your machine and run the introduction:
```bash
cargo install --path .
2019-01-09 14:02:47 -06:00
rustlings
```
2019-01-09 14:02:47 -06:00
If you choose to not install the `rustlings` command, just replace `rustlings` with `cargo run` in the rest of this text.
## Doing exercises
2019-01-09 14:02:47 -06:00
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.
2019-01-09 14:02:47 -06:00
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.
To compile and run a single exercise you can use `rustlings run <path to the exercise>`.
In case you get stuck, there is usually a hint at the bottom of each exercise.
### Need help?
If you need more help or would like to compare solutions, you can ask in [#rust-beginners on
irc.mozilla.org](https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-beginners ), the
[user forum](https://users.rust-lang.org/), or [the subreddit](https://reddit.com/r/rust). If an
exercise could be improved in any way, please [create an
issue](https://github.com/carols10cents/rustlings/issues/new) or submit a pull request!