2023-05-17 11:11:49 -04:00
< div class = "oranda-hide" >
2024-04-18 11:17:21 -04:00
# Rustlings 🦀❤️
2015-09-14 22:32:54 -04:00
2023-05-17 11:11:49 -04:00
< / div >
2024-04-18 11:17:21 -04: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!
2018-11-26 06:27:14 -05:00
2024-04-18 11:17:21 -04:00
It is recommended to do the Rustlings exercises in parallel to reading [the official Rust book ](https://doc.rust-lang.org/book/ ), the most comprehensive resource for learning Rust 📚️
2018-11-26 09:07:34 -05:00
2024-04-18 11:17:21 -04:00
[Rust By Example ](https://doc.rust-lang.org/rust-by-example/ ) is another recommended resource that you might find helpful.
It contains code examples and exercises similar to Rustlings, but online.
2018-11-26 09:07:34 -05:00
2019-01-09 15:02:47 -05:00
## Getting Started
2024-04-18 11:17:21 -04:00
### Installing Rust
2019-03-06 14:25:27 -05:00
2024-04-18 11:17:21 -04:00
Before installing Rustlings, you need to have _Rust installed_ .
Visit [www.rust-lang.org/tools/install ](https://www.rust-lang.org/tools/install ) for further instructions on installing Rust.
This'll also install _Cargo_ , Rust's package/project manager.
2019-03-06 14:25:27 -05:00
2024-04-18 11:17:21 -04:00
🐧 If you're on Linux, make sure you've installed `gcc` (for a linker). Deb: `sudo apt install build-essential gcc` . Dnf: `sudo dnf install gcc` .
2018-11-26 06:27:14 -05:00
2024-04-18 11:17:21 -04:00
🍎 If you're on MacOS, make sure you've installed Xcode and its developer tools by typing `xcode-select --install` .
2018-11-26 06:27:14 -05:00
2024-04-18 11:17:21 -04:00
### Installing Rustlings
2018-11-26 09:07:34 -05:00
2024-04-18 11:17:21 -04:00
The following command will download and compile Rustlings:
2018-11-26 09:07:34 -05:00
2019-01-23 15:36:08 -05:00
```bash
2024-04-18 11:17:21 -04:00
cargo install rustlings --locked
2019-01-23 15:36:08 -05:00
```
2024-04-18 11:17:21 -04:00
### Initialization
2019-01-23 15:36:08 -05:00
2024-04-18 11:17:21 -04:00
After installing Rustlings, run the following command to initialize the `rustlings/` directory:
2018-11-26 09:07:34 -05:00
2019-01-23 15:36:08 -05:00
```bash
2024-04-18 11:17:21 -04:00
rustlings init
2019-01-23 15:36:08 -05:00
```
2024-04-18 11:17:21 -04:00
Now, go into the newly initialized directory and run Rustlings for further instructions on getting started with the exercises:
2021-06-30 06:05:49 -04:00
```bash
2024-04-18 11:17:21 -04:00
cd rustlings/
rustlings
2021-06-30 06:05:49 -04:00
```
2024-04-18 11:17:21 -04:00
## 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 keeps them from compiling, and it's up to you to fix it!
Some exercises are also run as tests, but Rustlings handles them all the same.
To run the exercises in the recommended order, execute:
2019-11-11 12:02:56 -05:00
2022-03-29 09:04:52 -04:00
```bash
2024-04-18 11:17:21 -04:00
rustlings
2019-11-11 12:02:56 -05:00
```
2018-11-26 06:27:14 -05:00
2024-04-18 11:17:21 -04:00
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.
In case you want to go by your own order, or want to only verify a single exercise, you can run:
2021-06-30 06:05:49 -04:00
2022-03-29 09:04:52 -04:00
```bash
2024-04-18 11:17:21 -04:00
rustlings run EXERCISE_NAME
2021-06-30 06:05:49 -04:00
```
2024-04-18 11:17:21 -04:00
Or simply use the following command to run the next pending exercise in the course:
2022-03-29 09:04:52 -04:00
2021-04-18 10:07:30 -04:00
```bash
2024-04-18 11:17:21 -04:00
rustlings run
2021-04-18 10:07:30 -04:00
```
2024-04-18 11:17:21 -04:00
In case you get stuck, you can run the following command to get a hint for your exercise:
2019-01-23 15:36:08 -05:00
2024-04-18 11:17:21 -04:00
```bash
rustlings hint EXERCISE_NAME
```
You can also get the hint for the next pending exercise with the following command:
```bash
rustlings hint
```
## Quizzes
After every couple of sections, there will be a quiz that'll test your knowledge on a bunch of sections at once.
2024-04-21 19:07:36 -04:00
These quizzes are found in `exercises/quizzes` .
2019-01-23 15:36:08 -05:00
2020-07-12 03:44:11 -04:00
## Continuing On
2024-04-18 11:17:21 -04:00
<!-- TODO: Mention third - party exercises -->
Once you've completed Rustlings, put your new knowledge to good use!
Continue practicing your Rust skills by building your own projects, contributing to Rustlings, or finding other open-source projects to contribute to.
2020-07-12 03:44:11 -04:00
2020-12-29 05:23:08 -05:00
## Uninstalling Rustlings
2024-04-18 11:17:21 -04:00
If you want to remove Rustlings from your system, there are two steps.
1️ ⃣ Remove the `rustlings` directory that was created by `rustlings init` :
2020-12-29 05:23:08 -05:00
2022-03-29 09:04:52 -04:00
```bash
2024-04-18 11:17:21 -04:00
rm -r rustlings
2020-12-29 05:23:08 -05:00
```
2024-04-18 11:17:21 -04:00
2️ ⃣ Run `cargo uninstall` to remove the `rustlings` binary:
2020-12-29 05:23:08 -05:00
2022-03-29 09:04:52 -04:00
```bash
2020-12-29 05:23:08 -05:00
cargo uninstall rustlings
```
2024-04-18 11:17:21 -04:00
That's it!
2020-12-29 05:23:08 -05:00
2019-01-23 15:36:08 -05:00
## Contributing
2023-09-04 08:49:52 -04:00
See [CONTRIBUTING.md ](https://github.com/rust-lang/rustlings/blob/main/CONTRIBUTING.md ).
2024-04-18 10:17:33 -04:00
## Contributors ✨
2024-04-18 11:17:21 -04:00
Thanks to [all the wonderful contributors ](https://github.com/rust-lang/rustlings/graphs/contributors ) 🎉