Thanks to visit codestin.com
Credit goes to github.com

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

Readme quickstart #167

Merged
merged 1 commit into from
May 22, 2019
Merged

Readme quickstart #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 41 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the other Install section be removed?


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/).