From 1b288f91e4fc537c2571be42cfd1dbd72f080d23 Mon Sep 17 00:00:00 2001 From: Bruno Date: Thu, 24 Jun 2021 16:21:28 +0000 Subject: [PATCH] docs: move README to docs --- README.md => docs/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename README.md => docs/README.md (82%) diff --git a/README.md b/docs/README.md similarity index 82% rename from README.md rename to docs/README.md index 35a1aac8..7c846788 100644 --- a/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ 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 @@ -20,14 +20,14 @@ 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](./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 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) -2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases +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: @@ -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. -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 @@ -62,11 +62,11 @@ Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co ## FAQ -See [./docs/FAQ.md](./docs/FAQ.md). +See [./FAQ.md](./FAQ.md). ## Want to help? -See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details. +See [CONTRIBUTING](./CONTRIBUTING.md) for details. ## Hiring