Skip to content

Commit 9db1ae5

Browse files
committed
Fix docs
1 parent 5baf166 commit 9db1ae5

27 files changed

+86
-562
lines changed

.editorconfig

Lines changed: 0 additions & 6 deletions
This file was deleted.

.github/CODEOWNERS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
* @code-asher @kylecarbs
2-
Dockerfile @nhooyr
1+
* @code-asher @nhooyr

.github/CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Contributing
2+
3+
- [VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
4+
5+
```shell
6+
yarn
7+
yarn watch # Visit http://localhost:8080 once completed.
8+
```
9+
10+
If you run into issues about a different version of Node being used, try running
11+
`npm rebuild` in the VS Code directory.
12+
13+
If changes are made to the patch and you've built previously you must manually
14+
reset VS Code then run `yarn patch:apply`.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/extension_bug.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/workflows/ci.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: ci
2+
on: [push, pull_request]
3+
4+
jobs:
5+
fmt:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v1
9+
- uses: actions/cache@v1
10+
with:
11+
path: ~/go/pkg/mod
12+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
13+
restore-keys: |
14+
${{ runner.os }}-go-
15+
- name: make fmt
16+
uses: ./ci/image
17+
with:
18+
args: make fmt
19+
20+
lint:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@v1
24+
- uses: actions/cache@v1
25+
with:
26+
path: ~/go/pkg/mod
27+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
28+
restore-keys: |
29+
${{ runner.os }}-go-
30+
- name: make lint
31+
uses: ./ci/image
32+
with:
33+
args: make lint
34+
35+
test:
36+
runs-on: ubuntu-latest
37+
steps:
38+
- uses: actions/checkout@v1
39+
- uses: actions/cache@v1
40+
with:
41+
path: ~/go/pkg/mod
42+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
43+
restore-keys: |
44+
${{ runner.os }}-go-
45+
- name: make test
46+
uses: ./ci/image
47+
with:
48+
args: make test
49+
env:
50+
COVERALLS_TOKEN: ${{ secrets.github_token }}
51+
- name: Upload coverage.html
52+
uses: actions/upload-artifact@master
53+
with:
54+
name: coverage
55+
path: ci/out/coverage.html

.node-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

.npmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

.prettierrc.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
printWidth: 120
22
semi: false
3-
tabWidth: 2
4-
singleQuote: false
5-
trailingComma: es5
6-
useTabs: false
3+
trailingComma: all
74
arrowParens: always

.stylelintrc.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
extends:
2-
- stylelint-config-standard
2+
- stylelint-config-recommended
3+
- stylelint-config-prettier

LICENSE renamed to LICENSE.txt

File renamed without changes.

README.md

Lines changed: 6 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,17 @@
1-
# code-server · [![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cdr/code-server/blob/master/LICENSE) [!["Latest Release"](https://img.shields.io/github/release/cdr/code-server.svg)](https://github.com/cdr/code-server/releases/latest) [![Build Status](https://img.shields.io/travis/com/cdr/code-server/master)](https://github.com/cdr/code-server)
1+
# code-server
2+
[![release](https://img.shields.io/github/v/release/cdr/code-server?color=5d75ac&sort=semver)](https://github.com/cdr/code-server/releases)
3+
[![ci](https://img.shields.io/travis/com/cdr/code-server?label=ci)](https://travis-ci.com/cdr/code-server)
24

3-
`code-server` is [VS Code](https://github.com/Microsoft/vscode) running on a
4-
remote server, accessible through the browser.
5+
`code-server` is [VS Code](https://github.com/Microsoft/vscode) accessible through the browser.
56

67
Try it out:
78

89
```bash
9-
docker run -it -p 127.0.0.1:8080:8080 -v "$PWD:/home/coder/project" codercom/code-server
10+
docker run -it -p 127.0.0.1:8080:8080 codercom/code-server
1011
```
1112

12-
- **Consistent environment:** Code on your Chromebook, tablet, and laptop with a
13-
consistent dev environment. Develop more easily for Linux if you have a
14-
Windows or Mac and pick up where you left off when switching workstations.
15-
- **Server-powered:** Take advantage of large cloud servers to speed up tests,
16-
compilations, downloads, and more. Preserve battery life when you're on the go
17-
since all intensive computation runs on your server.
18-
1913
![Screenshot](/doc/assets/ide.gif)
2014

21-
## VS Code
22-
23-
- See [our VS Code readme](./src/vscode) for more information about how
24-
code-server and VS Code work together.
25-
2615
## Getting Started
2716

2817
### Requirements
@@ -98,7 +87,7 @@ for free.
9887
Do not expose `code-server` to the open internet without SSL, whether built-in
9988
or through a proxy.
10089

101-
## Future
90+
## Roadmap
10291

10392
- **Stay up to date!** Get notified about new releases of `code-server`.
10493
![Screenshot](/doc/assets/release.gif)
@@ -109,33 +98,7 @@ or through a proxy.
10998
Use the `--disable-telemetry` flag to completely disable telemetry. We use the
11099
data collected to improve code-server.
111100

112-
## Contributing
113-
114-
### Development
115-
116-
- [VS Code prerequisites](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites)
117-
118-
```shell
119-
yarn
120-
yarn watch # Visit http://localhost:8080 once completed.
121-
```
122-
123-
If you run into issues about a different version of Node being used, try running
124-
`npm rebuild` in the VS Code directory.
125-
126-
If changes are made to the patch and you've built previously you must manually
127-
reset VS Code then run `yarn patch:apply`.
128-
129-
## License
130-
131-
[MIT](LICENSE)
132-
133101
## Enterprise
134102

135103
Visit [our enterprise page](https://coder.com) for more information about our
136104
enterprise offering.
137-
138-
## Commercialization
139-
140-
If you would like to commercialize code-server, please contact
141-

doc/assets/cros.png

-121 KB
Binary file not shown.

doc/assets/droplet.svg

Lines changed: 0 additions & 24 deletions
This file was deleted.

doc/assets/ide.gif

-2.29 MB
Binary file not shown.

doc/assets/release.gif

-65.9 KB
Binary file not shown.

doc/cros-install.md

Lines changed: 0 additions & 75 deletions
This file was deleted.

0 commit comments

Comments
 (0)