From bd2e55dcf3213b3e1e4a75b8966f9b926a1d73ea Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Thu, 4 Jun 2020 16:31:01 -0400 Subject: [PATCH] Make README more clear --- README.md | 8 +++----- ci/README.md | 5 +++-- ci/build/release-github-assets.sh | 2 +- doc/guide.md | 2 ++ doc/install.md | 6 +++--- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 0ee28c0f9..f9bac4a39 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md). +### Quick Install + We have a [script](./install.sh) to install code-server for Linux and macOS. It tries to use the system package manager if possible. @@ -36,14 +38,10 @@ curl -fsSL https://code-server.dev/install.sh | sh The install script will print out how to run and start using code-server. -If you believe an install script used with `curl | sh` is insecure, please give -[this wonderful blogpost](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) by -[sandstorm.io](https://sandstorm.io) a read. +### Manual Install Docs on the install script, manual installation and docker image are at [./doc/install.md](./doc/install.md). -We also highly recommend reading the [FAQ](./doc/FAQ.md) on the [Differences compared to VS Code](./doc/FAQ.md#differences-compared-to-vs-code). - ## FAQ See [./doc/FAQ.md](./doc/FAQ.md). diff --git a/ci/README.md b/ci/README.md index 9624988bf..310d1931c 100644 --- a/ci/README.md +++ b/ci/README.md @@ -22,10 +22,11 @@ Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) the updated version. 1. Summarize the major changes in the release notes and link to the relevant issues. 4. Wait for the artifacts in step 2 to build. -5. Run `yarn release:github-assets` to download the `release-packages` artifact and then +5. Run `yarn release:github-assets` to download the `release-packages` artifact and upload them to the draft release. 6. Run some basic sanity tests on one of the released packages. -7. Make sure the github release tag is the commit with the artifacts. +7. Make sure the github release tag is the commit with the artifacts. This is a bug in + `hub` where uploading assets in step 5 will break the tag. 8. Publish the release and merge the PR. 1. CI will automatically grab the artifacts and then: 1. Publish the NPM package from `npm-package`. diff --git a/ci/build/release-github-assets.sh b/ci/build/release-github-assets.sh index 7fba67703..f2d9ff8c3 100755 --- a/ci/build/release-github-assets.sh +++ b/ci/build/release-github-assets.sh @@ -11,7 +11,7 @@ main() { source ./ci/lib.sh download_artifact release-packages ./release-packages - local assets=(./release-packages/code-server*"$VERSION"*{.tar.gz,.deb,.rpm}) + local assets=(./release-packages/code-server*"$VERSION"*{.tar.gz,.zip,.deb,.rpm}) for i in "${!assets[@]}"; do assets[$i]="--attach=${assets[$i]}" done diff --git a/doc/guide.md b/doc/guide.md index 2cd720913..beba49d78 100644 --- a/doc/guide.md +++ b/doc/guide.md @@ -25,6 +25,8 @@ Further docs are at: - [FAQ](./FAQ.md) for common questions. - [CONTRIBUTING](../doc/CONTRIBUTING.md) for development docs +We highly recommend reading the [FAQ](./doc/FAQ.md) on the [Differences compared to VS Code](./doc/FAQ.md#differences-compared-to-vs-code) before beginning. + We'll walk you through acquiring a remote machine to run `code-server` on and then exposing `code-server` so you can securely access it. diff --git a/doc/install.md b/doc/install.md index bd0fac48e..d47edc8c4 100644 --- a/doc/install.md +++ b/doc/install.md @@ -4,7 +4,7 @@ - [install.sh](#installsh) - [Flags](#flags) - - [Detect Reference](#detect-reference) + - [Detection Reference](#detection-reference) - [Debian, Ubuntu](#debian-ubuntu) - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse) - [Arch Linux](#arch-linux) @@ -42,7 +42,7 @@ If you believe an install script used with `curl | sh` is insecure, please give [this wonderful blogpost](https://sandstorm.io/news/2015-09-24-is-curl-bash-insecure-pgp-verified-install) by [sandstorm.io](https://sandstorm.io) a read. -If you'd still prefer manual installation despite the below [detect reference](#detect-reference) and `--dry-run` +If you'd still prefer manual installation despite the below [detection reference](#detection-reference) and `--dry-run` then continue on for docs on manual installation. The [`install.sh`](../install.sh) script runs the _exact_ same commands presented in the rest of this document. @@ -56,7 +56,7 @@ commands presented in the rest of this document. - `--version=X.X.X` to install version `X.X.X` instead of latest. - `--help` to see full usage docs. -### Detect Reference +### Detection Reference - For Debian, Ubuntu and Raspbian it will install the latest deb package. - For Fedora, CentOS, RHEL and openSUSE it will install the latest rpm package.