Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit 74b72dd

Browse files
author
Nick Cameron
committed
Wrap README.md to 80 cols
For reprobates like me who like to read md files in source form.
1 parent 16e0213 commit 74b72dd

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,19 @@ us get additional docs and types for all of `std`.
100100
rustup component add rust-analysis
101101
```
102102

103-
_**Note:** in the future, we hope to move these setup steps to `rustup`, so that you only have one step to add IDE support._
103+
_**Note:** in the future, we hope to move these setup steps to `rustup`, so that
104+
you only have one step to add IDE support._
104105

105106
## Running
106107

107-
Though the RLS is built to work with many IDEs and editors, we currently use VSCode to test the RLS.
108+
Though the RLS is built to work with many IDEs and editors, we currently use
109+
VSCode to test the RLS.
108110

109111
To run with VSCode, you'll need a
110112
[recent VSCode version](https://code.visualstudio.com/download) installed.
111113

112-
Next, you'll need to run the VSCode extension (for this step, you'll need a recent [node](https://nodejs.org/en/) installed:
114+
Next, you'll need to run the VSCode extension (for this step, you'll need a
115+
recent [node](https://nodejs.org/en/) installed:
113116

114117
```
115118
git clone https://github.com/jonathandturner/rls_vscode.git
@@ -118,21 +121,26 @@ npm install
118121
code .
119122
```
120123

121-
VSCode will open into the `rls_vscode` project. From here, click the Debug button on the left-hand side (a bug with a line through it).
122-
Next, click the green triangle at the top. This will launch a new instance of VSCode with the `rls_vscode` plugin enabled. From there,
123-
you can open your Rust projects using the RLS.
124+
VSCode will open into the `rls_vscode` project. From here, click the Debug
125+
button on the left-hand side (a bug with a line through it). Next, click the
126+
green triangle at the top. This will launch a new instance of VSCode with the
127+
`rls_vscode` plugin enabled. From there, you can open your Rust projects using
128+
the RLS.
124129

125-
You'll know it's working when you see this in the status bar at the bottom, with a spinning indicator:
130+
You'll know it's working when you see this in the status bar at the bottom, with
131+
a spinning indicator:
126132

127133
`RLS analysis: working /`
128134

129135
Once you see:
130136

131137
`RLS analysis: done`
132138

133-
Then you have the full set of capabilities available to you. You can goto def, find all refs, rename, goto type, etc. Completions are
134-
also available using the heuristics that Racer provides. As you type, your code will be checked and error squiggles will be reported
135-
when errors occur. You can hover these squiggles to see the text of the error.
139+
Then you have the full set of capabilities available to you. You can goto def,
140+
find all refs, rename, goto type, etc. Completions are also available using the
141+
heuristics that Racer provides. As you type, your code will be checked and
142+
error squiggles will be reported when errors occur. You can hover these
143+
squiggles to see the text of the error.
136144

137145
## Configuration
138146

@@ -152,4 +160,5 @@ Currently we accept the following options:
152160

153161
## Contributing
154162

155-
You can look in the CONTRIBUTING.md in this repo to learn more about contributing to this project.
163+
You can look in the CONTRIBUTING.md in this repo to learn more about
164+
contributing to this project.

0 commit comments

Comments
 (0)