From 29e5c4a29346eb3a9062628a1ba4d67117b1a726 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Wed, 27 May 2020 16:48:11 -0400 Subject: [PATCH] Clarify npm docs in install.md --- doc/CONTRIBUTING.md | 4 ++-- doc/install.md | 3 ++- install.sh | 1 + 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index 4e308974..5e3f689c 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -51,13 +51,13 @@ yarn --production node . ``` -Now you can build the packages with: +Now you can build release packages with: ``` yarn release:standalone +# The standalone release is in ./release-standalone yarn test:standalone-release yarn package -# The standalone release is in ./release-standalone # .deb, .rpm and the standalone archive are in ./release-packages ``` diff --git a/doc/install.md b/doc/install.md index 307f20a8..cab44623 100644 --- a/doc/install.md +++ b/doc/install.md @@ -70,8 +70,9 @@ commands presented in the rest of this document. - If Homebrew is not installed it will install the latest standalone release into `~/.local`. - Add `~/.local/bin` to your `$PATH` to run code-server. -- If ran on an architecture with no releases, it will install the npm package with `yarn` or `npm`. +- If ran on an architecture with no releases, it will install the [npm package](#yarn-npm) with `yarn` or `npm`. - We only have releases for amd64 and arm64 presently. + - The [npm package](#yarn-npm) builds the native modules on postinstall. ## Debian, Ubuntu diff --git a/install.sh b/install.sh index 0f2683c9..44209ebb 100755 --- a/install.sh +++ b/install.sh @@ -51,6 +51,7 @@ Usage: - If ran on an architecture with no releases, it will install the npm package with yarn or npm. - We only have releases for amd64 and arm64 presently. + - The npm package builds the native modules on postinstall. It will cache all downloaded assets into ~/.cache/code-server