docs: move README into docs

BrunoQuaresma · web-flow · commit 7912809af1ba · 2021-06-28T11:27:17.000-03:00
Move README into docs
diff --git a/ci/build/build-release.sh b/ci/build/build-release.sh
@@ -22,7 +22,7 @@ main() {
   bundle_code_server
   bundle_vscode
 
-  rsync README.md "$RELEASE_PATH"
+  rsync ./docs/README.md "$RELEASE_PATH"
   rsync LICENSE.txt "$RELEASE_PATH"
   rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH"
 }
diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,10 @@
-# code-server &middot; [!["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)
+# code-server
 
-[![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)
+[!["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](./docs/assets/screenshot.png)
+![Screenshot](./assets/screenshot.png)
 
 ## Highlights
 
@@ -20,14 +19,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 +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.
 
-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 +61,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
 

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ main() {`
`22`	`22`	`bundle_code_server`
`23`	`23`	`bundle_vscode`
`24`	`24`
`25`		`- rsync README.md "$RELEASE_PATH"`
	`25`	`+ rsync ./docs/README.md "$RELEASE_PATH"`
`26`	`26`	`rsync LICENSE.txt "$RELEASE_PATH"`
`27`	`27`	`rsync ./lib/vscode/ThirdPartyNotices.txt "$RELEASE_PATH"`
`28`	`28`	`}`