code-server/README.md

67 lines
1.8 KiB
Markdown
Raw Normal View History

2020-02-19 03:07:01 +03:00
# code-server
2019-01-08 03:46:19 +03:00
2020-05-17 23:53:08 +03:00
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
2019-03-06 04:45:21 +03:00
2020-05-22 05:16:16 +03:00
![Screenshot](./doc/assets/screenshot.png)
## Highlights
2020-05-22 22:38:03 +03:00
- **Code everywhere**
- Code on your Chromebook, tablet, and laptop with a consistent development environment.
- Develop on a Linux machine and pick up from any device with a web browser.
- **Server-powered**
- Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
- Preserve battery life when you're on the go as all intensive tasks runs on your server.
- Make use of a spare computer you have lying around and turn it into a full development environment.
2020-05-18 03:47:33 +03:00
## Getting Started
2020-05-17 23:53:08 +03:00
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
2020-06-04 23:31:01 +03:00
### Quick Install
2020-06-13 17:56:50 +03:00
We have a [script](./install.sh) to install code-server for Linux, macOS and FreeBSD.
2020-05-22 06:53:02 +03:00
2020-05-22 05:16:16 +03:00
It tries to use the system package manager if possible.
2020-05-22 00:10:29 +03:00
First run to print out the install process:
2020-05-20 06:41:28 +03:00
```bash
2020-05-27 22:48:03 +03:00
curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run
```
2020-05-22 00:10:29 +03:00
Now to actually install:
```bash
2020-05-22 00:10:29 +03:00
curl -fsSL https://code-server.dev/install.sh | sh
```
2020-05-22 05:16:16 +03:00
The install script will print out how to run and start using code-server.
2020-06-04 23:31:01 +03:00
### Manual Install
2020-05-22 22:38:03 +03:00
2020-05-22 05:16:16 +03:00
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
2020-02-19 03:07:01 +03:00
## FAQ
2020-02-19 03:07:01 +03:00
See [./doc/FAQ.md](./doc/FAQ.md).
2019-01-08 03:46:19 +03:00
2020-03-20 00:53:31 +03:00
## Contributing
See [./doc/CONTRIBUTING.md](./doc/CONTRIBUTING.md).
2020-06-10 01:10:28 +03:00
## Hiring
We're looking for an engineer to help maintain code-server and
2020-06-12 09:32:40 +03:00
innovate on open source.
2020-06-10 01:10:28 +03:00
Our main office is in Austin, Texas. Remote is ok as long as
you're in Canada, the US, Australia or the UK.
Please get in [touch](mailto:anmol@coder.com) if interested.
## Enterprise
2019-09-27 17:39:29 +03:00
2020-05-18 00:57:59 +03:00
Visit [our website](https://coder.com) for more information about our
2020-02-19 03:07:01 +03:00
enterprise offerings.