cubetiq/code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Reformat readme intro

Browse Source
This commit is contained in:
Asher 2019-07-31 17:08:37 -05:00
parent bce0cac48f
commit 60ed0653bc
No known key found for this signature in database
GPG Key ID: D63C1EF81242354A
1 changed files with 32 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -1,4 +1,4 @@
# code-server [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/463752820026376202.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/zxSwN8Z) # code-server · [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![Build Status](https://img.shields.io/travis/com/cdr/code-server/master)](https://github.com/cdr/code-server)
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a `code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
remote server, accessible through the browser. remote server, accessible through the browser.
@ -8,12 +8,12 @@ Try it out:
docker run -it -p 127.0.0.1:8443:8443 -v "$PWD:/home/coder/project" codercom/code-server docker run -it -p 127.0.0.1:8443:8443 -v "$PWD:/home/coder/project" codercom/code-server
``` ```
- Code on your Chromebook, tablet, and laptop with a consistent dev environment. - **Consistent environment:** Code on your Chromebook, tablet, and laptop with a
- If you have a Windows or Mac workstation, more easily develop for Linux. consistent dev environment. develop more easily for Linux if you have a
- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. Windows or Mac, and pick up where you left off when switching workstations.
- Preserve battery life when you're on the go. - **Server-powered:** Take advantage of large cloud servers to speed up tests,
- All intensive computation runs on your server. compilations, downloads, and more. Preserve battery life when you're on the go
- You're no longer running excess instances of Chrome. since all intensive computation runs on your server.
![Screenshot](/doc/assets/ide.gif) ![Screenshot](/doc/assets/ide.gif)
@ -22,8 +22,7 @@ docker run -it -p 127.0.0.1:8443:8443 -v "$PWD:/home/coder/project" codercom/cod
Use [sshcode](https://github.com/codercom/sshcode) for a simple setup. Use [sshcode](https://github.com/codercom/sshcode) for a simple setup.
### Docker ### Docker
See docker oneliner mentioned above. Dockerfile is at See the Docker one-liner mentioned above. Dockerfile is at [/Dockerfile](/Dockerfile).
[/Dockerfile](/Dockerfile).
To debug Golang using the To debug Golang using the
[ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go), [ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go),
@ -32,8 +31,8 @@ arguments when launching code-server with Docker. See
[#725](https://github.com/cdr/code-server/issues/725) for details. [#725](https://github.com/cdr/code-server/issues/725) for details.
### Binaries ### Binaries
1. [Download a binary](https://github.com/cdr/code-server/releases) (Linux and 1. [Download a binary](https://github.com/cdr/code-server/releases). (Linux and
OS X supported. Windows coming soon). OS X supported. Windows coming soon)
2. Unpack the downloaded file then run the binary. 2. Unpack the downloaded file then run the binary.
3. In your browser navigate to `localhost:8443`. 3. In your browser navigate to `localhost:8443`.
@ -41,10 +40,9 @@ arguments when launching code-server with Docker. See
- For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md). - For hosting on cloud platforms see [doc/deploy.md](doc/deploy.md).
### Build ### Build
- If you also plan on developing, set the `OUT` environment variable: - If you also plan on developing, set the `OUT` environment variable. Otherwise
`export OUT=/path/to/some/directory`. Otherwise it will build in this it will build in this directory which will cause issues because `yarn watch`
directory which will cause issues because `yarn watch` will try to will try to compile the build directory as well.
compile the build directory as well.
- For now `@coder/nbin` is a global dependency. - For now `@coder/nbin` is a global dependency.
- Run `yarn build ${codeServerVersion} ${vscodeVersion} ${target} ${arch}` in - Run `yarn build ${codeServerVersion} ${vscodeVersion} ${target} ${arch}` in
this directory (for example: `yarn build development 1.36.0 linux x64`). this directory (for example: `yarn build development 1.36.0 linux x64`).
@ -68,10 +66,10 @@ arguments when launching code-server with Docker. See
- Run VS Code unit tests against our builds to ensure features work as expected. - Run VS Code unit tests against our builds to ensure features work as expected.
## Extensions ## Extensions
At the moment we can't use the official VSCode Marketplace. We've created a At the moment we can't use the official VS Code Marketplace. We've created a
custom extension marketplace focused around open-sourced extensions. However, custom extension marketplace focused around open-sourced extensions. However,
you can manually download the extension to your extensions directory. It's also you can manually download the extension to your extensions directory. It's also
possible to host your own marketplace by setting the `SERVICE_URL` and possible to set your own marketplace URLs by setting the `SERVICE_URL` and
`ITEM_URL` environment variables. `ITEM_URL` environment variables.
## Telemetry ## Telemetry
@ -106,23 +104,23 @@ the patch in the VS Code source, then run `yarn patch:generate` in this
directory. directory.
Our changes include: Our changes include:
- Add a `code-server` schema. - Add a `code-server` schema.
- Make the extension sidebar work in the browser. Mostly involves removing - Make the extension sidebar work in the browser. Mostly involves removing
Node-specific code for the `extensions` channel client and adding a Node-specific code for the `extensions` channel client and adding a
`gallery` channel. `gallery` channel.
- Allow multiple extension directories (both user and built-in). - Allow multiple extension directories (both user and built-in).
- Rewrite assets used in the CSS (like icons) or as images to use the base URL. - Rewrite assets used in the CSS (like icons) or as images to use the base URL.
- Change the loader to use the base URL. - Change the loader to use the base URL.
- Change the web socket to use the base URL and TLS if necessary. - Change the web socket to use the base URL and TLS if necessary.
- Set the favicon using a relative path. - Set the favicon using a relative path.
- Modify the file service to support writing from an asynchronous stream (for - Modify the file service to support writing from an asynchronous stream (for
uploading files). uploading files).
- Add a file prefix to ignore for temporary files created during upload. - Add a file prefix to ignore for temporary files created during upload.
- Insert our upload service for use in editor windows and explorer. - Insert our upload service for use in editor windows and explorer.
- Modify the log level to get its initial setting from the server. - Modify the log level to get its initial setting from the server.
- Get telemetry working by adding a channel for it. - Get telemetry working by adding a channel for it.
- Change a regular expression used for mnemonics so it works on Firefox. - Change a regular expression used for mnemonics so it works on Firefox.
- Make it possible for us to load code on the client. - Make it possible for us to load code on the client.
## License ## License
[MIT](LICENSE) [MIT](LICENSE)