Skip to content

Commit 1b288f9

Browse files
committed
docs: move README to docs
1 parent 4b0dd07 commit 1b288f9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md renamed to docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
77

8-
![Screenshot](./docs/assets/screenshot.png)
8+
![Screenshot](./assets/screenshot.png)
99

1010
## Highlights
1111

@@ -20,14 +20,14 @@ For a good experience, we recommend at least:
2020
- 1 GB of RAM
2121
- 2 cores
2222

23-
You can use whatever linux distribution floats your boat but in our [guide](./docs/guide.md) we assume Debian on Google Cloud.
23+
You can use whatever linux distribution floats your boat but in our [guide](./guide.md) we assume Debian on Google Cloud.
2424

2525
## Getting Started
2626

2727
There are three ways you can get started:
2828

29-
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
30-
2. Manually installing code-server; see [Installation](./docs/install.md) for instructions applicable to most use cases
29+
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)
30+
2. Manually installing code-server; see [Installation](./install.md) for instructions applicable to most use cases
3131
3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server)
3232

3333
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
4444

4545
When done, the install script prints out instructions for running and starting code-server.
4646

47-
We also have an in-depth [setup and configuration](./docs/guide.md) guide.
47+
We also have an in-depth [setup and configuration](./guide.md) guide.
4848

4949
### code-server --link
5050

@@ -62,11 +62,11 @@ Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
6262

6363
## FAQ
6464

65-
See [./docs/FAQ.md](./docs/FAQ.md).
65+
See [./FAQ.md](./FAQ.md).
6666

6767
## Want to help?
6868

69-
See [CONTRIBUTING](./docs/CONTRIBUTING.md) for details.
69+
See [CONTRIBUTING](./CONTRIBUTING.md) for details.
7070

7171
## Hiring
7272

0 commit comments

Comments
 (0)