From 8dbaec73dd627c02ab6b830d5cfcf820fe4c482f Mon Sep 17 00:00:00 2001 From: Bruno Date: Wed, 9 Jun 2021 16:52:50 +0000 Subject: [PATCH 1/2] chore(docs): add README to the docs --- docs/README.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000000..6851590c4d7c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,77 @@ +# code-server · [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) + +[![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) +[![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](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. + +![Screenshot](./assets/screenshot.png) + +## Highlights + +- Code on any device with a consistent development environment +- Use cloud servers to speed up tests, compilations, downloads, and more +- Preserve battery life when you're on the go; all intensive tasks run on your server + +## Requirements + +For a good experience, we recommend at least: + +- 1 GB of RAM +- 2 cores + +You can use whatever linux distribution floats your boat but in our [guide](./guide.md) we assume Debian on Google Cloud. + +## Getting Started + +There are three ways you can get started: + +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](./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) ⚡ + +If you choose to use the install script, you can preview what occurs during the install process: + +```bash +curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run +``` + +To install, run: + +```bash +curl -fsSL https://code-server.dev/install.sh | sh +``` + +When done, the install script prints out instructions for running and starting code-server. + +We also have an in-depth [setup and configuration](./guide.md) guide. + +### code-server --link + +We're working on a cloud platform that makes deploying and managing code-server easier. +Consider running code-server with the beta flag `--link` if you don't want to worry about + +- TLS +- Authentication +- Port Forwarding + +```bash +$ code-server --link +Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co +``` + +## FAQ + +See [./FAQ.md](./FAQ.md). + +## Want to help? + +See [CONTRIBUTING](./CONTRIBUTING.md) for details. + +## Hiring + +Interested in [working at Coder](https://coder.com)? Check out [our open positions](https://jobs.lever.co/coder)! + +## For Organizations + +Visit [our website](https://coder.com) for more information about remote development for your organization or enterprise. From 4513d1eb2a1477004b21b6af8160f29b5c44b52a Mon Sep 17 00:00:00 2001 From: Bruno Date: Wed, 9 Jun 2021 17:06:24 +0000 Subject: [PATCH 2/2] chore(docs): remove README badges --- docs/README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 6851590c4d7c..d4739263c498 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,4 @@ -# code-server · [!["GitHub Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/cdr/code-server/discussions) [!["Join us on Slack"](https://img.shields.io/badge/join-us%20on%20slack-gray.svg?longCache=true&logo=slack&colorB=brightgreen)](https://cdr.co/join-community) [![Twitter Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq) - -[![codecov](https://codecov.io/gh/cdr/code-server/branch/main/graph/badge.svg?token=5iM9farjnC)](https://codecov.io/gh/cdr/code-server) -[![See latest docs](https://img.shields.io/static/v1?label=Docs&message=see%20latest%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs) +# code-server Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.