Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning about rust-analyzer not working if you clone and use the repo directly #2131

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add warning about rust-analyzer not working if you clone and use the repo directly #2131

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a025ce0
Add warning about `rust-analyzer` not working if you clone and use th…
MadLittleMods Oct 14, 2024
60e0d4a
Fix some grammar
MadLittleMods Oct 16, 2024
2bccdcb
Use simple caution message with expand for more details
MadLittleMods Oct 16, 2024
fa6680f
Correctly point to sections
MadLittleMods Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@ cargo install rustlings

</details>

> [!CAUTION]
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've used caution but feel free to nit to warning or any other.

> 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.
Copy link
Author

@MadLittleMods MadLittleMods Oct 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to your exact wording ✅

I've kept the extra "Why?" background in a collapsible section since it feels like it adds a little bit of something that makes it more understandable and convincing. Happy to remove to get this shipped if you prefer.

>
> <details>
> <summary>Why?</summary>
>
>The intended way to run Rustlings is to install the binary and run `rustlings init` as described in the installation/initialization sections. 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:
Expand Down