Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-25 12:33:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: remove unnecessary prerequisites setup.md

Browse source
This commit is contained in:
David Kurilla 2024-10-22 08:44:02 -07:00 committed by David Kurilla
parent 9ee29f4254
commit 0719432903
1 changed files with 3 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/dev/setup.md
View file

@ -1,17 +1,11 @@
# Setup Guide
This guide gives a simplified opinionated setup for developers contributing to rust-analyzer.
This guide gives a simplified opinionated setup for developers contributing to rust-analyzer using Visual Studio Code to make changes and Visual Studio Code Insiders to test those changes. This guide will assume you have Visual Studio Code and Visual Studio Code Insiders installed.
## Prerequisites
Since rust-analyzer is a Rust project, you will need to install Rust. You can download and install the latest stable version of Rust [here](https://www.rust-lang.org/tools/install).
You will also need Visual Studio Code and Visual Studio Code Insiders for this workflow. You can download and install Visual Studio Code [here](https://code.visualstudio.com/Download) and you can download and install Visual Studio Code Insiders [here](https://code.visualstudio.com/insiders/).
You will also need to install the rust-analyzer extension for Visual Studio Code and Visual Studio Code Insiders.
More information about Rust on Visual Studio Code can be found [here](https://code.visualstudio.com/docs/languages/rust)
## Step-by-Step Setup
**Step 01**: Fork the rust-analyzer repository and clone the fork to your local machine.
@ -27,7 +21,7 @@ cargo xtask install --server --code-bin code-insiders --dev-rel
```
In the output of this command, there should be a file path provided to the installed binary on your local machine.
It should look something like the following output below
It should look something like the following output below:
```
Installing <path-to-rust-analyzer-binary>
@ -60,4 +54,4 @@ cargo xtask install --server --code-bin code-insiders --dev-rel` to reinstall th
Now on Visual Studio Code Insiders, we should be able to open the Output tab on our terminal and switch to Rust Analyzer Language Server to see the `eprintln!` statement we just wrote.
If you are able to see your output, you now have a complete workflow for debugging rust-analyzer.
If you are able to see your output, you now have a complete workflow for debugging rust-analyzer.