wbrawner/code-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor readme updates and fixes

Browse source
This commit is contained in:
Asher 2019-11-05 13:49:18 -06:00
parent cee0ac213c
commit 2ad2582cc0
No known key found for this signature in database
GPG key ID: D63C1EF81242354A
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -60,14 +60,14 @@ arguments when launching code-server with Docker. See
### Build ### Build
See See
[VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites) [VS Code's prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
before building. before building.
```shell ```shell
export OUT=/path/to/output/build # Optional if only building. Required if also developing. export OUT=/path/to/output/build # Optional if only building. Required if also developing.
yarn build ${vscodeVersion} ${codeServerVersion} # See travis.yml for the VS Code version to use. yarn build ${vscodeVersion} ${codeServerVersion} # See travis.yml for the VS Code version to use.
# The code-server version can be anything you want. # The code-server version can be anything you want.
node ~/path/to/output/build/out/vs/server/main.js # You can run the built JavaScript with Node. node /path/to/output/build/out/vs/server/main.js # You can run the built JavaScript with Node.
yarn binary ${vscodeVersion} ${codeServerVersion} # Or you can package it into a binary. yarn binary ${vscodeVersion} ${codeServerVersion} # Or you can package it into a binary.
``` ```
@ -135,7 +135,7 @@ data collected to improve code-server.
### Development ### Development
See See
[VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites) [VS Code's prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
before developing. before developing.
```shell ```shell
@ -155,8 +155,7 @@ yarn start
``` ```
If you run into issues about a different version of Node being used, try running If you run into issues about a different version of Node being used, try running
`npm rebuild` in the VS Code directory and ignore the error at the end from `npm rebuild` in the VS Code directory.
`vscode-ripgrep`.
### Upgrading VS Code ### Upgrading VS Code
@ -171,7 +170,6 @@ directory.
Our changes include: Our changes include:
- Change the remote schema to `code-server`.
- Allow multiple extension directories (both user and built-in). - Allow multiple extension directories (both user and built-in).
- Modify the loader, websocket, webview, service worker, and asset requests to - Modify the loader, websocket, webview, service worker, and asset requests to
use the URL of the page as a base (and TLS if necessary for the websocket). use the URL of the page as a base (and TLS if necessary for the websocket).