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

docs: move README to docs

This commit is contained in:
Bruno 2021-06-24 16:21:28 +00:00
parent 4b0dd07634
commit 1b288f91e4
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md → docs/README.md
View File

@ -5,7 +5,7 @@
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
![Screenshot](./docs/assets/screenshot.png) ![Screenshot](./assets/screenshot.png)
## Highlights ## Highlights
@ -20,14 +20,14 @@ For a good experience, we recommend at least:
- 1 GB of RAM - 1 GB of RAM
- 2 cores - 2 cores
You can use whatever linux distribution floats your boat but in our [guide](./docs/guide.md) we assume Debian on Google Cloud. You can use whatever linux distribution floats your boat but in our [guide](./guide.md) we assume Debian on Google Cloud.
## Getting Started ## Getting Started
There are three ways you can get started: There are three ways you can get started:
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible) 1. Using the [install script](https://github.com/cdr/code-server/blob/main/install.sh), which automates most of the process. The script uses the system package manager (if possible)
2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases 2. Manually installing code-server; see [Installation](./install.md) for instructions applicable to most use cases
3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server) ⚡ 3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server) ⚡
If you choose to use the install script, you can preview what occurs during the install process: If you choose to use the install script, you can preview what occurs during the install process:
@ -44,7 +44,7 @@ curl -fsSL https://code-server.dev/install.sh | sh
When done, the install script prints out instructions for running and starting code-server. When done, the install script prints out instructions for running and starting code-server.
We also have an in-depth [setup and configuration](./docs/guide.md) guide. We also have an in-depth [setup and configuration](./guide.md) guide.
### code-server --link ### code-server --link
@ -62,11 +62,11 @@ Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
## FAQ ## FAQ
See [./docs/FAQ.md](./docs/FAQ.md). See [./FAQ.md](./FAQ.md).
## Want to help? ## Want to help?
See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details. See [CONTRIBUTING](./CONTRIBUTING.md) for details.
## Hiring ## Hiring