Skip to content

Commit 1a195c5

Browse files
committed
Documentation fixes
1 parent 9be46b3 commit 1a195c5

File tree

6 files changed

+26
-16
lines changed

6 files changed

+26
-16
lines changed

README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,24 @@
22

33
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
44

5-
- **Code everywhere:** Code on your Chromebook, tablet, and laptop with a
6-
consistent dev environment. Develop on a Linux machine and pick up from any
7-
device with a web browser.
8-
- **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
9-
Preserve battery life when you're on the go since all intensive tasks runs on your server.
10-
Make use of a spare computer you have lying around and turn it into a full development environment.
5+
![Example screenshot](./doc/assets/screenshot.jpeg)
116

12-
![Example gif](./doc/assets/screenshot.png)
7+
### Code everywhere
8+
9+
Code on your Chromebook, tablet, and laptop with a
10+
consistent dev environment. Develop on a Linux machine and pick up from any
11+
device with a web browser.
12+
13+
### Server-powered
14+
15+
Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
16+
Preserve battery life when you're on the go since all intensive tasks runs on your server.
17+
Make use of a spare computer you have lying around and turn it into a full development environment.
1318

1419
## Getting Started
1520

1621
For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
1722

18-
## Install
19-
2023
We have a script to install code-server on Linux or macOS preferring to use the system package manager.
2124

2225
First run to print out the install process:
@@ -31,7 +34,9 @@ Now to actually install:
3134
curl -fsSL https://code-server.dev/install.sh | sh
3235
```
3336

34-
Docs on the install script, manual installation and docker instructions are at [./doc/install.md](./doc/install.md).
37+
The install script will print out how to run and start using code-server.
38+
39+
Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md).
3540

3641
## FAQ
3742

ci/build/build-packages.sh

+8-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@ main() {
1111
mkdir -p release-packages
1212

1313
release_archive
14-
if [[ $OS == linux && $ARCH == "amd64" ]]; then
15-
# Will stop most of the auto update issues.
16-
# For the other releases it's more important to not pollute the release listing.
17-
ARCH=x86_64 release_archive
14+
# Will stop the auto update issues and allow people to upgrade their scripts
15+
# for the new release structure.
16+
if [[ $ARCH == "amd64" ]]; then
17+
if [[ $OS == "linux" ]]; then
18+
ARCH=x86_64 release_archive
19+
elif [[ $OS == "macos" ]]; then
20+
OS=darwin ARCH=x86_64 release_archive
21+
fi
1822
fi
1923

2024
if [[ $OSTYPE == linux* ]]; then

ci/build/code-server.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ bin_dir() {
1717
}
1818

1919
BIN_DIR=$(bin_dir)
20-
if [ "$(uname)" = "Linux"]; then
20+
if [ "$(uname)" = "Linux" ]; then
2121
export LD_LIBRARY_PATH="$BIN_DIR/../lib${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH}"
2222
else
23-
export DYLD_LIBRARY_PATH="$BIN_DIR/../lib${LD_LIBRARY_PATH+:$LD_LIBRARY_PATH}"
23+
export DYLD_LIBRARY_PATH="$BIN_DIR/../lib${DYLD_LIBRARY_PATH+:$DYLD_LIBRARY_PATH}"
2424
fi
2525
exec "$BIN_DIR/../lib/node" "$BIN_DIR/.." "$@"

doc/assets/screenshot.jpeg

211 KB
Loading

doc/assets/screenshot.png

-524 KB
Binary file not shown.

install.sh

+1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ echo_static_postinstall() {
6363
echo
6464
cat << EOF
6565
Static release has been installed into $STATIC_INSTALL_PREFIX/lib/code-server-$VERSION
66+
6667
Please extend your path to use code-server:
6768
PATH="$STATIC_INSTALL_PREFIX/bin:\$PATH"
6869
Then you can run:

0 commit comments

Comments
 (0)