diff options
author | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-02-10 21:37:57 +0000 |
---|---|---|
committer | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-02-10 21:37:57 +0000 |
commit | 81852f6dd2c1bf86da440d9216959baa9a0a5ed2 (patch) | |
tree | e35e18680523251dcfa302b8b50bdd77ce5297f5 /editors/README.md | |
parent | ffd407affff967884fd51a977335469e819c7194 (diff) | |
parent | 943c064ffc7920d7a43215979f87109e060c558c (diff) |
Merge #780
780: Mention node.js requirement in readme r=DJMcNab a=Matthias247
I tried building rust-analyzer according to the instructions, but it failed with a very non-descriptive error:
> will run: npm ci
> Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }
It took me a while to figure out I had an outdated node version installed, which didn't support `npm ci`. I think mentioning the requirement explicitly might prevent others from running into the same issue.
Co-authored-by: Matthias Einwag <[email protected]>
Diffstat (limited to 'editors/README.md')
-rw-r--r-- | editors/README.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/editors/README.md b/editors/README.md index 2d6a3f21d..eb1004914 100644 --- a/editors/README.md +++ b/editors/README.md | |||
@@ -1,4 +1,12 @@ | |||
1 | To install experimental VS Code plugin: | 1 | |
2 | Preqrequisites: | ||
3 | |||
4 | In order to build the VS Code plugin, you need to have node.js and npm with | ||
5 | a minimum version of 10 installed. Please refer to | ||
6 | [node.js and npm documentation](https://nodejs.org) for installation instructions. | ||
7 | |||
8 | The experimental VS Code plugin can then be built and installed by executing the | ||
9 | following commands: | ||
2 | 10 | ||
3 | ``` | 11 | ``` |
4 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 | 12 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 |