From 9d35204d6f6e29f7054024229feb6a09648afc78 Mon Sep 17 00:00:00 2001 From: Nathan Potter Date: Wed, 22 May 2019 16:05:57 -0500 Subject: [PATCH] Add quick start to README (#167) --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 41 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 55f6cb5..0841ef7 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,6 @@ to open a project right from the command line. ![Demo](/site/demo.gif) -## Install - -```bash -curl https://sail.dev/install.sh | bash -``` - ## Features - **No more "It works on my machine"**, everyone working on the same project is working in the same environment. @@ -38,3 +32,44 @@ curl https://sail.dev/install.sh | bash Documentation is available at [https://sail.dev/docs](https://sail.dev/docs/introduction/). Or, you can read it in it's markdown form at [site/content/docs.](site/content/docs) + +## Quick Start + +### Requirements + +**Currently Sail supports both Linux and MacOS. Windows support is planned for a future release.** + +Before using Sail, there are several dependencies that must be installed on the host system: + +- [Docker](https://docs.docker.com/install/) +- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +- [Chrome](https://www.google.com/chrome/) or [Chromium](https://www.chromium.org/getting-involved/download-chromium) - not required, but strongly recommended for best [code-server](https://github.com/cdr/code-server) support. +If chrome is not installed, the default browser will be used. + + +### Install + +For simple, secure and fast installation, the following command will install the latest version +of sail for your OS and architecture into `/usr/local/bin`. You will need to have `/usr/local/bin` +in your [$PATH](https://superuser.com/questions/284342/what-are-path-and-other-environment-variables-and-how-can-i-set-or-use-them) in order to use it. + +``` +curl https://sail.dev/install.sh | bash +``` + +### Verify the Installation + +To verify Sail is properly installed, run `sail --help` on your system. If everything is installed correctly, you should see Sail's help text. + +### Run + +You should now be able to run `sail run cdr/sail` from your terminal to start an environment designed for working +on the Sail repo. + +### Browser Extension + +To open GitHub or GitLab projects in a Sail environment with a single click, see the [browser extension install instructions](https://sail.dev/docs/browser-extension/). + +### Learn More + +Additional docs covering concepts and configuration can be found at [https://sail.dev/docs](https://sail.dev/docs/introduction/).