mirror of
https://github.com/rust-lang/rustlings.git
synced 2024-12-25 23:10:30 +00:00
Use simple caution message with expand for more details
This commit is contained in:
parent
60e0d4ae8a
commit
2bccdcbd2c
1 changed files with 12 additions and 9 deletions
21
README.md
21
README.md
|
@ -45,6 +45,18 @@ cargo install rustlings
|
||||||
|
|
||||||
</details>
|
</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
|
### Initialization
|
||||||
|
|
||||||
After installing Rustlings, run the following command to initialize the `rustlings/` directory:
|
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).
|
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.
|
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
|
### Terminal
|
||||||
|
|
||||||
While working with Rustlings, please use a modern terminal for the best user experience.
|
While working with Rustlings, please use a modern terminal for the best user experience.
|
||||||
|
|
Loading…
Reference in a new issue