From 9858af9014a00d9d5054c33830b23e10ef146586 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Tue, 19 May 2020 00:16:47 -0400 Subject: [PATCH 1/2] Mention yarn as another installation option --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8f24123a..440e5f22 100644 --- a/README.md +++ b/README.md @@ -33,18 +33,19 @@ systemctl --user enable --now code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` -### npm +### yarn, npm -We recommend installing from `npm` if we don't have a precompiled release for your machine's +We recommend installing with `yarn` or `npm` if we don't have a precompiled release for your machine's platform or architecture or your glibc < v2.19. -**note:** Installing via `npm` builds native modules on install and so requires C dependencies. +**note:** Installing via `yarn` or `npm` builds native modules on install and so requires C dependencies. See [./doc/npm.md](./doc/npm.md) for installing these dependencies. You will need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633). ```bash -npm install -g code-server +yarn global add code-server +# Or: npm install -g code-server code-server # Now visit http://127.0.0.1:8080. Your password is in ~/.config/code-server/config.yaml ``` From 5ec8a6efbd19950d1a94b0c56fcf66d968b2f3a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sandro=20J=C3=A4ckel?= Date: Tue, 19 May 2020 12:19:09 +0200 Subject: [PATCH 2/2] Fix typos --- ci/build/build-release.sh | 2 +- doc/guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ci/build/build-release.sh b/ci/build/build-release.sh index 35673f04..6ef0d4d5 100755 --- a/ci/build/build-release.sh +++ b/ci/build/build-release.sh @@ -73,7 +73,7 @@ EOF # We remove the scripts field so that later on we can run # yarn to fetch node_modules if necessary without build scripts running. - # We cannot use --no-scripts because we still want dependant package scripts to run. + # We cannot use --no-scripts because we still want dependent package scripts to run. jq 'del(.scripts)' < "$VSCODE_SRC_PATH/package.json" > "$VSCODE_OUT_PATH/package.json" } diff --git a/doc/guide.md b/doc/guide.md index fa6d7b9f..2b882ba6 100644 --- a/doc/guide.md +++ b/doc/guide.md @@ -136,7 +136,7 @@ If you want to make the SSH port forwarding persistent we recommend using [mutagen](https://mutagen.io/documentation/introduction/installation). ``` -# Same as the above SSH command but runs in the background continously. +# Same as the above SSH command but runs in the background continuously. # Add `mutagen daemon start` to your ~/.bashrc to start the mutagen daemon when you open a shell. mutagen forward create --name=code-server tcp:127.0.0.1:8080 :tcp:127.0.0.1:8080 ```