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

Use simple caution message with expand for more details

Browse source
This commit is contained in:
Eric Eastwood 2024-10-16 11:07:42 -05:00
parent 60e0d4ae8a
commit 2bccdcbd2c
1 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -45,6 +45,18 @@ cargo install rustlings
</details>
> [!CAUTION]
> Don't try to clone the repository to do the exercises! `rust-analyzer` won't work in that case. Please follow the instructions above instead.
>
> <details>
> <summary>Why?</summary>
>
>The intended way to run Rustlings is to install the binary and run `rustlings init` as described above. This generates a `Cargo.toml` (different than what you see in the repository) that includes each exercise as a separate binary target which is enough for `rust-analyzer` to work.
>
>If you just clone the repository and try to run and edit the exercises directly, the language server will not work.
>
> </details>
### Initialization
After installing Rustlings, run the following command to initialize the `rustlings/` directory:
@ -82,15 +94,6 @@ rustlings
Our general recommendation is [VS Code](https://code.visualstudio.com/) with the [rust-analyzer plugin](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer).
But any editor that supports [rust-analyzer](https://rust-analyzer.github.io/) should be enough for working on the exercises.
<details>
<summary><strong>If you cloned the repository and <code>rust-analyzer</code> isn't working…</strong> (<em>click to expand</em>)</summary>
The intended way to run Rustlings is to install the binary and run `rustlings init` as described above. This generates a `Cargo.toml` (different than what you see in the repository) that includes each excersise as a separate binary target which is enough for `rust-analyzer` to work.
If you just clone the repository and try to run and edit the exercises directly, the language server will not work. Please follow the instructions above instead.
</details>
### Terminal
While working with Rustlings, please use a modern terminal for the best user experience.