Skip to content

Commit 29e5c4a

Browse files
committed
Clarify npm docs in install.md
1 parent f71d887 commit 29e5c4a

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

doc/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ yarn --production
5151
node .
5252
```
5353

54-
Now you can build the packages with:
54+
Now you can build release packages with:
5555

5656
```
5757
yarn release:standalone
58+
# The standalone release is in ./release-standalone
5859
yarn test:standalone-release
5960
yarn package
60-
# The standalone release is in ./release-standalone
6161
# .deb, .rpm and the standalone archive are in ./release-packages
6262
```
6363

doc/install.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,9 @@ commands presented in the rest of this document.
7070
- If Homebrew is not installed it will install the latest standalone release into `~/.local`.
7171
- Add `~/.local/bin` to your `$PATH` to run code-server.
7272

73-
- If ran on an architecture with no releases, it will install the npm package with `yarn` or `npm`.
73+
- If ran on an architecture with no releases, it will install the [npm package](#yarn-npm) with `yarn` or `npm`.
7474
- We only have releases for amd64 and arm64 presently.
75+
- The [npm package](#yarn-npm) builds the native modules on postinstall.
7576

7677
## Debian, Ubuntu
7778

install.sh

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Usage:
5151
- If ran on an architecture with no releases, it will install the
5252
npm package with yarn or npm.
5353
- We only have releases for amd64 and arm64 presently.
54+
- The npm package builds the native modules on postinstall.
5455
5556
It will cache all downloaded assets into ~/.cache/code-server
5657

0 commit comments

Comments
 (0)