From 2bccdcbd2cbc2006885a2b375a05b06a10b28684 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Wed, 16 Oct 2024 11:07:42 -0500 Subject: [PATCH] Use simple caution message with expand for more details --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index abc8507d..f97a25ee 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,18 @@ cargo install rustlings +> [!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. +> +>
+> Why? +> +>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. +> +>
+ ### 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. -
-If you cloned the repository and rust-analyzer isn't working… (click to expand) - -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. - -
- ### Terminal While working with Rustlings, please use a modern terminal for the best user experience.