Skip to content

Commit 056e669

Browse files
committed
Edit README
1 parent 7e1e9d1 commit 056e669

File tree

1 file changed

+16
-30
lines changed

1 file changed

+16
-30
lines changed

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,72 +6,58 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a
66

77
## Highlights
88

9-
- **Code everywhere**
10-
- Code on your Chromebook, tablet, and laptop with a consistent development environment.
11-
- Develop on a Linux machine and pick up from any device with a web browser.
12-
- **Server-powered**
13-
- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
14-
- Preserve battery life when you're on the go as all intensive tasks run on your server.
15-
- Make use of a spare computer you have lying around and turn it into a full development environment.
9+
- Code on any device with a consistent development environment
10+
- Use cloud servers to speed up tests, compilations, downloads, and more
11+
- Preserve battery life when you're on the go; all intensive tasks run on your server
1612

1713
## Getting Started
1814

19-
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
15+
There are two ways to get started:
2016

21-
### Quick Install
17+
1. Using the [install script](./install.sh), which automates most of the process. The script uses the system package manager (if possible)
18+
2. Manually installing code-server; see [Installation](./doc/install.md#quick-install) for instructions applicable to most use cases
2219

23-
We have a [script](./install.sh) to install code-server for Linux, macOS and FreeBSD.
24-
25-
It tries to use the system package manager if possible.
26-
27-
First run to print out the install process:
20+
If you choose to use the install script, you can preview what occurs during the install process:
2821

2922
```bash
3023
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
3124
```
3225

33-
Now to actually install:
26+
To install, run:
3427

3528
```bash
3629
curl -fsSL https://code-server.dev/install.sh | sh
3730
```
3831

39-
The install script will print out how to run and start using code-server.
40-
41-
### Manual Install
32+
When done, the install script prints out instructions for running and starting code-server.
4233

43-
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
34+
We also have an in-depth [setup and configuration](./doc/guide.md) guide.
4435

4536
### Alpha Program 🐣
4637

47-
We're working on a cloud platform to make deploying and managing code-server easier. If you don't want to worry about
38+
We're working on a cloud platform that makes deploying and managing code-server easier. Consider [joining our alpha program](https://codercom.typeform.com/to/U4IKyv0W) if you don't want to worry about
4839

4940
- TLS
5041
- Authentication
5142
- Port Forwarding
5243

53-
consider [joining our alpha program](https://codercom.typeform.com/to/U4IKyv0W).
54-
5544
## FAQ
5645

5746
See [./doc/FAQ.md](./doc/FAQ.md).
5847

59-
## Contributing
48+
## Want to help?
6049

61-
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
50+
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for additional details.
6251

6352
## Hiring
6453

65-
We ([@cdr](https://github.com/cdr)) are looking for engineers to help maintain
66-
code-server, innovate on open source and streamline dev workflows.
54+
We ([@cdr](https://github.com/cdr)) are looking for engineers to help [maintain
55+
code-server](https://jobs.lever.co/coder/e40becde-2cbd-4885-9029-e5c7b0a734b8), innovate on open source, and streamline dev workflows.
6756

6857
Our main office is in Austin, Texas. Remote is ok as long as
6958
you're in North America or Europe.
7059

71-
Please get in [touch](mailto:[email protected]) with your resume/github if interested.
72-
73-
We're also hiring someone specifically to help maintain code-server.
74-
See the listing [here](https://jobs.lever.co/coder/e40becde-2cbd-4885-9029-e5c7b0a734b8).
60+
Please get in [touch](mailto:[email protected]) with your resume/GitHub if interested.
7561

7662
## For Organizations
7763

0 commit comments

Comments
 (0)