Skip to content

Commit

Permalink
Consolidate editor recommendations in main text (#1217)
Browse files Browse the repository at this point in the history
This streamlines the text about editors by simply mentioning them.
RustRover is mentioned last since it's new and I don't have any
experience with it yet.
  • Loading branch information
mgeisler authored Sep 18, 2023
1 parent aba8bf3 commit 3121bff
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions src/cargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,23 @@ and how it fits into this training.

> **Please follow the instructions on <https://rustup.rs/>.**
This will give you the Cargo build tool (`cargo`) and the Rust compiler (`rustc`). You will also get `rustup`, a command line utility that you can use to install/switch toolchains, setup cross compilation, etc.
This will give you the Cargo build tool (`cargo`) and the Rust compiler (`rustc`). You will also get `rustup`, a command line utility that you can use to install to different compiler versions.

<details>

* On Debian/Ubuntu, you can also install Cargo, the Rust source and the [Rust formatter][6] via `apt`. However, this gets you an outdated rust version and may lead to unexpected behavior. The command would be:
After installing Rust, you should configure your editor or IDE to work with Rust. Most editors do this by talking to [rust-analyzer], which provides auto-completion and jump-to-definition functionality for [VS Code], [Emacs], [Vim/Neovim], and many others. There is also a different IDE available called [RustRover].

```shell
sudo apt install cargo rust-src rustfmt
```
<details>

* We suggest using [VS Code][2] to edit the code (but any LSP compatible editor works with [rust-analyzer][3]).
* On Debian/Ubuntu, you can also install Cargo, the Rust source and the [Rust formatter] via `apt`. However, this gets you an outdated rust version and may lead to unexpected behavior. The command would be:

* Some folks also like to use the [JetBrains][4] family of feature-rich IDEs, which offer timely support, regular updates, and an out-of-the-box experience. If you prefer them, you can use [RustRover][5], which as of September 2023 is still available as a (free) preview. It will eventually replace the Rust plugin which can also be used in, e.g., their CLion IDE.
```shell
sudo apt install cargo rust-src rustfmt
```

</details>

[2]: https://code.visualstudio.com/
[3]: https://rust-analyzer.github.io/
[4]: https://www.jetbrains.com/
[5]: https://www.jetbrains.com/rust/
[6]: https://github.com/rust-lang/rustfmt
[rust-analyzer]: https://rust-analyzer.github.io/
[VS Code]: https://code.visualstudio.com/
[Emacs]: https://rust-analyzer.github.io/manual.html#emacs
[Vim/Neovim]: https://rust-analyzer.github.io/manual.html#vimneovim
[RustRover]: https://www.jetbrains.com/rust/
[Rust formatter]: https://github.com/rust-lang/rustfmt

0 comments on commit 3121bff

Please sign in to comment.