You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-26
Original file line number
Diff line number
Diff line change
@@ -6,62 +6,58 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a
6
6
7
7
## Highlights
8
8
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
16
12
17
13
## Getting Started
18
14
19
-
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
15
+
There are two ways to get started:
20
16
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) for instructions applicable to most use cases
22
19
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:
28
21
29
22
```bash
30
23
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
31
24
```
32
25
33
-
Now to actually install:
26
+
To install, run:
34
27
35
28
```bash
36
29
curl -fsSL https://code-server.dev/install.sh | sh
37
30
```
38
31
39
-
The install script will print out how to run and start using code-server.
32
+
When done, the install script prints out instructions for running and starting code-server.
33
+
34
+
We also have an in-depth [setup and configuration](./doc/guide.md) guide.
40
35
41
-
### Manual Install
36
+
### Alpha Program 🐣
42
37
43
-
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
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
39
+
40
+
- TLS
41
+
- Authentication
42
+
- Port Forwarding
44
43
45
44
## FAQ
46
45
47
46
See [./doc/FAQ.md](./doc/FAQ.md).
48
47
49
-
## Contributing
48
+
## Want to help?
50
49
51
-
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
50
+
See [CONTRIBUTING](./doc/CONTRIBUTING.md) for details.
52
51
53
52
## Hiring
54
53
55
-
We ([@cdr](https://github.com/cdr)) are looking for engineers to help maintain
56
-
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.
57
56
58
57
Our main office is in Austin, Texas. Remote is ok as long as
59
58
you're in North America or Europe.
60
59
61
-
Please get in [touch](mailto:[email protected]) with your resume/github if interested.
62
-
63
-
We're also hiring someone specifically to help maintain code-server.
64
-
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.
0 commit comments