Skip to content
This repository has been archived by the owner on Apr 28, 2020. It is now read-only.

Commit

Permalink
Add quick start to README (#167)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Potter committed May 22, 2019
1 parent 305c3d3 commit 9d35204
Showing 1 changed file with 41 additions and 6 deletions.
47 changes: 41 additions & 6 deletions README.md
Expand Up @@ -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.
Expand All @@ -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/).

0 comments on commit 9d35204

Please sign in to comment.