mirror of
https://github.com/rust-lang/rustlings.git
synced 2024-12-26 23:36:30 +00:00
126 lines
5.1 KiB
Markdown
126 lines
5.1 KiB
Markdown
|
|
|
|
# rustlings 🦀❤️
|
|
|
|
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!
|
|
|
|
_...looking for the old, web-based version of Rustlings? Try [here](https://github.com/rust-lang/rustlings/tree/rustlings-1)_
|
|
|
|
Alternatively, for a first-time Rust learner, there's several other resources:
|
|
|
|
- [The Book](https://doc.rust-lang.org/book/index.html) - The most comprehensive resource for learning Rust, but a bit theoretical sometimes. You will be using this along with Rustlings!
|
|
- [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
|
|
|
|
## Getting Started
|
|
|
|
_Note: If you're on MacOS, make sure you've installed Xcode and its developer tools by typing `xcode-select --install`._
|
|
|
|
_Note: If you have Xcode 10+ installed, you also need to install the package file found at `/Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg`._
|
|
|
|
You will need to have Rust installed. You can get it by visiting https://rustup.rs. This'll also install Cargo, Rust's package/project manager.
|
|
|
|
## MacOS/Linux
|
|
|
|
Just run:
|
|
|
|
```bash
|
|
curl -L https://git.io/rustlings | bash
|
|
# Or if you want it to be installed to a different path:
|
|
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
|
|
|
|
Basically: Clone the repository, checkout to the latest tag, run `cargo install`.
|
|
|
|
```bash
|
|
git clone https://github.com/rust-lang/rustlings
|
|
cd rustlings
|
|
git checkout tags/1.0.0 # or whatever the latest version is (find out at https://github.com/rust-lang/rustlings/releases/latest)
|
|
cargo install --force --path .
|
|
```
|
|
|
|
Same as above, run `rustlings` to get started.
|
|
|
|
## 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.
|
|
|
|
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
|
|
```
|
|
|
|
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:
|
|
|
|
```bash
|
|
rustlings watch
|
|
```
|
|
|
|
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.
|
|
|
|
In case you want to go by your own order, or want to only verify a single exercise, you can run:
|
|
|
|
```bash
|
|
rustlings run exercises/path/to/exercise.rs
|
|
```
|
|
|
|
In case you get stuck, there is usually a hint at the bottom of each exercise.
|
|
|
|
## Testing yourself
|
|
|
|
After every couple of sections, there will be a test that'll test your knowledge on a bunch of sections at once. These tests are found in `exercises/testN.rs`.
|
|
|
|
## Completion
|
|
|
|
Rustlings isn't done; there are a couple of sections that are very experimental and don't have proper documentation. These include:
|
|
|
|
- Errors (`exercises/errors/`)
|
|
- Option (`exercises/option/`)
|
|
- Result (`exercises/result/`)
|
|
- Move Semantics (could still be improved, `exercises/move_semantics/`)
|
|
|
|
Additionally, we could use exercises on a couple of topics:
|
|
|
|
- Structs
|
|
- Better ownership stuff
|
|
- `impl`
|
|
- ??? probably more
|
|
|
|
If you are interested in improving or adding new ones, please feel free to contribute! Read on for more information :)
|
|
|
|
## Contributing
|
|
|
|
### Adding an exercise
|
|
|
|
First step is to add the exercise! Call it `exercises/yourTopic/yourTopicN.rs`, make sure to
|
|
put in some helpful links, and link to sections of the book in `exercises/yourTopic/README.md`.
|
|
|
|
Next you want to make sure it runs when using `rustlings`. All exercises are stored in `info.toml`, under the `exercises` array. They're ordered by the order they're ran when using `rustlings verify`.
|
|
|
|
You want to make sure where in the file you add your exercise. If you're not sure, add it at the bottom and ask in your pull request. To add an exercise, edit the file like this:
|
|
```diff
|
|
...
|
|
+ [[exercises]]
|
|
+ path = "exercises/yourTopic/yourTopicN.rs"
|
|
+ mode = "compile"
|
|
...
|
|
```
|
|
|
|
The `mode` attribute decides whether Rustlings will only compile your exercise, or compile and test it. If you have tests to verify in your exercise, choose `test`, otherwise `compile`.
|
|
|
|
That's all! Feel free to put up a pull request.
|
|
|
|
### Working on the source code
|
|
|
|
`rustlings` is basically a glorified `rustc` wrapper. Therefore the source code
|
|
isn't really that complicated since the bulk of the work is done by `rustc`.
|
|
`src/main.rs` contains a simple `clap` CLI that loads from `src/verify.rs` and `src/run.rs`.
|
|
|
|
## Credits
|
|
|
|
`rustlings` was originally written by [Carol](https://github.com/carols10cents)!
|
|
|