summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormo8it <mo8it@proton.me>2024-04-18 17:17:21 +0200
committermo8it <mo8it@proton.me>2024-04-18 17:17:21 +0200
commitdaa090981aeafb24ed907cf85de49904ce17fc37 (patch)
tree2f6fbc498d284928d35c93c406c0dcb89c26b4d8
parentaaf183142e27e8a3232481dfd6bdc09e4403aeeb (diff)
Update README
-rw-r--r--README.md100
1 files changed, 66 insertions, 34 deletions
diff --git a/README.md b/README.md
index 36e771b..bfa3f06 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,124 @@
<div class="oranda-hide">
-# rustlings 🦀❤️
+# Rustlings 🦀❤️
</div>
-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!
+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!
-Alternatively, for a first-time Rust learner, there are several other resources:
+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 📚️
-- [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
+[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.
## 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're on Linux, make sure you've installed gcc. Deb: `sudo apt install gcc`. Yum: `sudo yum -y install gcc`._
+### Installing Rust
-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.
+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.
-<!-- TODO: Installation with Cargo -->
+🐧 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`.
-## Doing exercises
+🍎 If you're on MacOS, make sure you've installed Xcode and its developer tools by typing `xcode-select --install`.
-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.
+### Installing Rustlings
-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:
+The following command will download and compile Rustlings:
```bash
-rustlings watch
+cargo install rustlings --locked
```
-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.
+### Initialization
-In case you want to go by your own order, or want to only verify a single exercise, you can run:
+After installing Rustlings, run the following command to initialize the `rustlings/` directory:
```bash
-rustlings run myExercise1
+rustlings init
```
-Or simply use the following command to run the next unsolved exercise in the course:
+Now, go into the newly initialized directory and run Rustlings for further instructions on getting started with the exercises:
```bash
-rustlings run next
+cd rustlings/
+rustlings
```
-In case you get stuck, you can run the following command to get a hint for your
-exercise:
+## 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:
```bash
-rustlings hint myExercise1
+rustlings
```
-You can also get the hint for the next unsolved exercise with the following command:
+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:
```bash
-rustlings hint next
+rustlings run EXERCISE_NAME
```
-To check your progress, you can run the following command:
+Or simply use the following command to run the next pending exercise in the course:
```bash
-rustlings list
+rustlings run
```
-## Testing yourself
+In case you get stuck, you can run the following command to get a hint for your exercise:
-After every couple of sections, there will be a quiz that'll test your knowledge on a bunch of sections at once. These quizzes are found in `exercises/quizN.rs`.
+```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.
+These quizzes are found in `exercises/quizN.rs`.
## Continuing On
-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.
+<!-- 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.
## Uninstalling Rustlings
-If you want to remove Rustlings from your system, there are two steps. First, you'll need to remove the exercises folder that the install script created
-for you:
+If you want to remove Rustlings from your system, there are two steps.
+
+1️⃣ Remove the `rustlings` directory that was created by `rustlings init`:
```bash
-rm -rf rustlings # or your custom folder name, if you chose and or renamed it
+rm -r rustlings
```
-Second, run `cargo uninstall` to remove the `rustlings` binary:
+2️⃣ Run `cargo uninstall` to remove the `rustlings` binary:
```bash
cargo uninstall rustlings
```
-Now you should be done!
+That's it!
## Contributing
@@ -94,4 +126,4 @@ See [CONTRIBUTING.md](https://github.com/rust-lang/rustlings/blob/main/CONTRIBUT
## Contributors ✨
-Thanks to [all the wonderful contributors](https://github.com/rust-lang/rustlings/graphs/contributors) 🎉❤️
+Thanks to [all the wonderful contributors](https://github.com/rust-lang/rustlings/graphs/contributors) 🎉