Skip to content

Commit c5bfe6d

Browse files
author
Katie Horne
committed
Edit README
1 parent e9d4f87 commit c5bfe6d

File tree

1 file changed

+36
-20
lines changed

1 file changed

+36
-20
lines changed

docs/README.md

+36-20
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
[!["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 v3.10.2 docs](https://img.shields.io/static/v1?label=Docs&message=see%20v3.10.2%20&color=blue)](https://github.com/cdr/code-server/tree/v3.10.2/docs)
44

5-
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
5+
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and
6+
access it in the browser.
67

78
![Screenshot](./assets/screenshot.png)
89

910
## Highlights
1011

1112
- Code on any device with a consistent development environment
1213
- Use cloud servers to speed up tests, compilations, downloads, and more
13-
- Preserve battery life when you're on the go; all intensive tasks run on your server
14+
- Preserve battery life when you're on the go; all intensive tasks run on your
15+
server
1416

1517
## Requirements
1618

@@ -19,17 +21,25 @@ For a good experience, we recommend at least:
1921
- 1 GB of RAM
2022
- 2 cores
2123

22-
You can use whatever linux distribution floats your boat but in our [guide](https://coder.com/docs/code-server/v3.10.2/guide) we assume Debian on Google Cloud.
24+
You can use any Linux distribution, but [our
25+
docs](https://coder.com/docs/code-server/v3.10.2/guide) assume that you're using
26+
Debian hosted by Google Cloud.
2327

24-
## Getting Started
28+
## Getting started
2529

2630
There are three ways you can get started:
2731

28-
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)
29-
2. Manually installing code-server; see [Installation](https://coder.com/docs/code-server/v3.10.2/install) for instructions applicable to most use cases
30-
3. Use our one-click buttons and guides to [deploy code-server to a popular cloud provider](https://github.com/cdr/deploy-code-server)
32+
1. Using the [install
33+
script](https://github.com/cdr/code-server/blob/main/install.sh), which
34+
automates most of the process. The script uses the system package manager if
35+
possible.
36+
2. Manually [installing
37+
code-server](https://coder.com/docs/code-server/v3.10.2/install)
38+
3. Using our one-click buttons and guides to [deploy code-server to a cloud
39+
provider](https://github.com/cdr/deploy-code-server)
3140

32-
If you choose to use the install script, you can preview what occurs during the install process:
41+
If you use the install script, you can preview what occurs during the install
42+
process:
3343

3444
```bash
3545
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
@@ -41,37 +51,43 @@ To install, run:
4151
curl -fsSL https://code-server.dev/install.sh | sh
4252
```
4353

44-
When done, the install script prints out instructions for running and starting code-server.
54+
When done, the install script prints out instructions for running and starting
55+
code-server.
4556

46-
We also have an in-depth [setup and configuration](https://coder.com/docs/code-server/v3.10.2/guide) guide.
57+
We also have an in-depth [setup and
58+
configuration](https://coder.com/docs/code-server/v3.10.2/guide) guide.
4759

4860
### code-server --link
4961

50-
We're working on a cloud platform that makes deploying and managing code-server easier.
51-
Consider running code-server with the beta flag `--link` if you don't want to worry about
62+
We're working on a cloud platform that makes deploying and managing code-server
63+
easier. Consider running code-server with the beta flag `--link` if you don't
64+
want to worry about:
5265

5366
- TLS
5467
- Authentication
55-
- Port Forwarding
68+
- Port forwarding
5669

5770
```bash
5871
$ code-server --link
59-
Proxying code-server, you can access your IDE at https://valmar-jon.cdr.co
72+
Proxying code-server, you can access your IDE at https://example.cdr.co
6073
```
6174

62-
## FAQ
75+
## Questions?
6376

64-
See [./FAQ.md](https://coder.com/docs/code-server/v3.10.2/FAQ).
77+
See answers to [frequently asked
78+
questions](https://coder.com/docs/code-server/v3.10.2/FAQ).
6579

6680
## Want to help?
6781

68-
See [CONTRIBUTING](https://coder.com/docs/code-server/v3.10.2/CONTRIBUTING) for details.
82+
See [Contributing](https://coder.com/docs/code-server/v3.10.2/CONTRIBUTING) for
83+
details.
6984

7085
## Hiring
7186

72-
Interested in [working at Coder](https://coder.com/careers)? Check out [our open positions](https://coder.com/careers#openings)!
87+
Interested in [working at Coder](https://coder.com/careers)? Check out [our open
88+
positions](https://coder.com/careers#openings)!
7389

7490
## For Organizations
7591

76-
Want remote development for your organization or enterprise? Visit
77-
[our website](https://coder.com) to learn more about Coder.
92+
Want remote development for your organization or enterprise? Visit [our
93+
website](https://coder.com) to learn more about Coder.

0 commit comments

Comments
 (0)