Documentation fixes

This commit is contained in:
Anmol Sethi
2020-05-21 22:16:16 -04:00
parent 15cd727b96
commit 7dcfde7329
7 changed files with 75 additions and 47 deletions

View File

@@ -2,6 +2,10 @@
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
![Screenshot](./doc/assets/screenshot.png)
## Highlights
- **Code everywhere:** Code on your Chromebook, tablet, and laptop with a
consistent dev environment. Develop on a Linux machine and pick up from any
device with a web browser.
@@ -9,15 +13,12 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a
Preserve battery life when you're on the go since all intensive tasks runs on your server.
Make use of a spare computer you have lying around and turn it into a full development environment.
![Example gif](./doc/assets/screenshot.png)
## Getting Started
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
## Install
We have a script to install code-server on Linux or macOS preferring to use the system package manager.
[We have a script](./install.sh) to install code-server for Linux or macOS.
It tries to use the system package manager if possible.
First run to print out the install process:
@@ -31,7 +32,9 @@ Now to actually install:
curl -fsSL https://code-server.dev/install.sh | sh
```
Docs on the install script, manual installation and docker instructions are at [./doc/install.md](./doc/install.md).
The install script will print out how to run and start using code-server.
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
## FAQ