mirror of
https://git.tuxpa.in/a/code-server.git
synced 2025-02-18 18:09:18 +00:00
docs: move README into docs
Move README into docs
This commit is contained in:
commit
7912809af1
@ -22,7 +22,7 @@ main() {
|
|||||||
bundle_code_server
|
bundle_code_server
|
||||||
bundle_vscode
|
bundle_vscode
|
||||||
|
|
||||||
rsync README.md "$RELEASE_PATH"
|
rsync ./docs/README.md "$RELEASE_PATH"
|
||||||
rsync LICENSE.txt "$RELEASE_PATH"
|
rsync LICENSE.txt "$RELEASE_PATH"
|
||||||
rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH"
|
rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH"
|
||||||
}
|
}
|
||||||
|
@ -1,11 +1,10 @@
|
|||||||
# code-server · [](https://github.com/cdr/code-server/discussions) [](https://cdr.co/join-community) [](https://twitter.com/coderhq)
|
# code-server
|
||||||
|
|
||||||
[](https://codecov.io/gh/cdr/code-server)
|
[](https://github.com/cdr/code-server/discussions) [](https://cdr.co/join-community) [](https://twitter.com/coderhq) [](https://codecov.io/gh/cdr/code-server) [](https://github.com/cdr/code-server/tree/v3.10.2/docs)
|
||||||
[](https://github.com/cdr/code-server/tree/v3.10.2/docs)
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Highlights
|
## Highlights
|
||||||
|
|
||||||
@ -20,14 +19,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 +43,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 +61,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
|
||||||
|
|
Loading…
Reference in New Issue
Block a user