Skip to content
This repository was archived by the owner on Mar 19, 2024. It is now read-only.

Commit 8599d99

Browse files
committed
Add readme gif + tweak text
Remove rls.toml workspace advice (default on latest Rls)
1 parent 43fc02a commit 8599d99

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# IDE-Rust
22
Rust language support for Atom-IDE, powered by the Rust Language Server (RLS).
33

4+
![](http://image.ibb.co/gwfQTm/output.gif "Usage Jan-2018")
5+
46
## Features
57
- Auto-completion
68
- Format on save (disabled by default, see `atom-ide-ui` settings)
@@ -29,7 +31,8 @@ Or you can install from Settings view by searching for `ide-rust`.
2931
No other packages or manual setup is required as these will be handled with user prompts after install.
3032

3133
## Multi-crate projects
32-
A root `Cargo.toml` is required in each atom project, however cargo workspaces can be used to support multiple crates in a single project. For example, a project with _'rust_foo'_ & _'rust_bar'_ directories/crates could have the following root `Cargo.toml`
34+
A root `Cargo.toml` is required in each atom project, however cargo workspaces can be used to support multiple crates in a single project.
35+
For example, a project with *'rust_foo'* & *'rust_bar'* directories/crates could have the following root `Cargo.toml`
3336
```toml
3437
# Cargo.toml
3538
[workspace]
@@ -38,19 +41,14 @@ members = [
3841
"rust_bar",
3942
]
4043
```
41-
Rls does not currently support workspaces by default, so this must be manually enabled:
42-
```toml
43-
# rls.toml
44-
workspace_mode = true
45-
```
4644

4745
## Overriding Rls
4846
The Rls command can be specified manually, for example to run from local source code:
4947
```cson
5048
# config.cson
5149
...
5250
"ide-rust":
53-
rlsCommandOverride: "rustup run nightly cargo run --manifest-path=/rls-src/Cargo.toml --release"
51+
rlsCommandOverride: "cargo +nightly run --manifest-path=/rls-src/Cargo.toml"
5452
```
5553
When set you'll be able to see, and remove, this from the package settings. After restarting atom an info message will inform you the override is in place.
5654

0 commit comments

Comments
 (0)