tristan/rustlings
1
0
Fork 0
mirror of https://github.com/rust-lang/rustlings.git synced 2024-12-25 23:10:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Small writing changes

Browse source
This commit is contained in:
mo8it 2024-07-02 16:26:59 +02:00
parent d3a0c26999
commit 2f8fa469ac
3 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CHANGELOG.md
View file

@ -32,23 +32,28 @@ You can enter it by entering `l` in the watch mode.
It offers the following features: It offers the following features:
- Browse all exercises and see their state (pending/done). - Browse all exercises and see their state (pending/done).
- Filter exercises based on their state (done/pending). - Filter exercises based on their state (pending/done).
- Continue at another exercise. This allows you to skip some exercises or go back to previous ones. - Continue at another exercise. This allows you to skip some exercises or go back to previous ones.
- Reset an exercise so that you can start over and revert your changes. - Reset an exercise so you can start over and revert your changes.
### Solutions ### Solutions
After finishing an exercise, a solution file will be available and Rustlings will show you its path in green. After finishing an exercise, a solution file will be available and Rustlings will show you its path in green.
This allows you to compare your solution with an idiomatic solution and maybe learn about other ways to solve a problem. This allows you to compare your solution with an idiomatic solution and maybe learn about other ways to solve a problem.
While writing the solutions, all exercises have been polished 🌟
For example, every exercise now contains `TODO` comments to highlight what the user needs to change and where.
### LSP support out of the box ### LSP support out of the box
Instead of creating a `project.json` file using `rustlings lsp`, Rustlings now works with a `Cargo.toml` file. Instead of creating a `project.json` file using `rustlings lsp`, Rustlings now works with a `Cargo.toml` file out of the box.
No actions are needed to activate the language server `rust-analyzer`.
This should avoid issues related to the language server or to running exercises, especially the ones with Clippy. This should avoid issues related to the language server or to running exercises, especially the ones with Clippy.
### Clippy ### Clippy
Clippy lints are now shown on all exercises! 📎 Clippy lints are now shown on all exercises, not only the Clippy exercises 📎
Make Clippy your friend from early on 🥰 Make Clippy your friend from early on 🥰
### Third party exercises ### Third party exercises
@ -56,7 +61,7 @@ Make Clippy your friend from early on 🥰
Rustlings now supports third-party exercises! Rustlings now supports third-party exercises!
Do you want to create your own set of Rustlings exercises to focus on some specific topic? Do you want to create your own set of Rustlings exercises to focus on some specific topic?
Or did you want to translate the original Rustlings exercises? Or do you want to translate the original Rustlings exercises?
Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)! Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)!
<a name="5.6.1"></a> <a name="5.6.1"></a>

2
README.md
View file

@ -123,7 +123,7 @@ Continue practicing your Rust skills by building your own projects, contributing
## Third-Party Exercises ## Third-Party Exercises
Do you want to create your own set of Rustlings exercises to focus on some specific topic? Do you want to create your own set of Rustlings exercises to focus on some specific topic?
Or did you want to translate the original Rustlings exercises? Or do you want to translate the original Rustlings exercises?
Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)! Then follow the link to the guide about [third-party exercises](THIRD_PARTY_EXERCISES.md)!
## Uninstalling Rustlings ## Uninstalling Rustlings

8
THIRD_PARTY_EXERCISES.md
View file

@ -1,14 +1,14 @@
# Third-Party Exercises # Third-Party Exercises
The support of Rustlings for third-party exercises allows you to create your own set of Rustlings exercises to focus on some specific topic. The support of Rustlings for third-party exercises allows you to create your own set of Rustlings exercises to focus on some specific topic.
You could also offer a translatation of the original Rustlings exercises as a third-party exercises. You could also offer a translatation of the original Rustlings exercises as third-party exercises.
## Getting started ## Getting started
To create third-party exercises, install Rustlings and run `rustlings dev new PROJECT_NAME`. To create third-party exercises, install Rustlings and run `rustlings dev new PROJECT_NAME`.
This command will, similar to `cargo new PROJECT_NAME`, create a template directory called `PROJECT_NAME` with all what you need to get started. This command will, similar to `cargo new PROJECT_NAME`, create a template directory called `PROJECT_NAME` with all what you need to get started.
Read the comments in the generated `info.toml` file to understand the format of this file. Read the comments in the generated `info.toml` file to understand its format.
It allows you to set a custom welcome and final message and specify the metadata of every exercise. It allows you to set a custom welcome and final message and specify the metadata of every exercise.
## Create an exercise ## Create an exercise
@ -46,8 +46,8 @@ Now, add more exercises and publish them as a Git repository.
Users just have to clone that repository and run `rustlings` in it to start working on your set of exercises just like the official ones. Users just have to clone that repository and run `rustlings` in it to start working on your set of exercises just like the official ones.
One difference to the official exercises is that the solution files will not be hidden until the user finishes an exercise. One difference to the official exercises is that the solution files will not be hidden until the user finishes an exercise.
But you can trust the user to not look at the solution too early ;) But you can trust the users to not look at the solution too early 😉
## Share ## Share
After publishing your set of exercises, open a pull request in the official Rustlings repository to link to your project in the README 😃 After publishing your set of exercises, open an issue or a pull request in the official Rustlings repository to link to your project in the README 😃