Docs copyedits: README.md + CONTRIBUTING.md (#2242 )

* Edit README

* Edit CONTRIBUTING

* Format CONTRIBUTING.MD

* Incorporate feedback

* Revert movement of CONTRIBUTING.MD and format

2020-10-29 17:21:47 -04:00

2.5 KiB

Raw Blame History

code-server ·

Run VS Code on any machine anywhere and access it in the browser.

Highlights

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

Getting Started

There are two ways to get started:

Using the install script, which automates most of the process. The script uses the system package manager (if possible)
Manually installing code-server; see Installation for instructions applicable to most use cases

If you choose to use the install script, you can preview what occurs during the install process:

curl -fsSL https://code-server.dev/install.sh | sh -s -- --dry-run

To install, run:

curl -fsSL https://code-server.dev/install.sh | sh

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

We also have an in-depth setup and configuration guide.

Alpha Program 🐣

We're working on a cloud platform that makes deploying and managing code-server easier. Consider joining our alpha program if you don't want to worry about

TLS
Authentication
Port Forwarding

FAQ

See ./doc/FAQ.md.

Want to help?

See CONTRIBUTING for details.

Hiring

We (@cdr) are looking for engineers to help maintain code-server, innovate on open source, and streamline dev workflows.

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

Please get in touch with your resume/GitHub if interested.

For Organizations

Visit our website for more information about remote development for your organization or enterprise.

2.5 KiB Raw Blame History