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.

Commit b77a1b4

Browse files
author
Nathan Potter
committed
Add quick start to README
1 parent 305c3d3 commit b77a1b4

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

README.md

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ to open a project right from the command line.
2121

2222
![Demo](/site/demo.gif)
2323

24-
## Install
25-
26-
```bash
27-
curl https://sail.dev/install.sh | bash
28-
```
29-
3024
## Features
3125

3226
- **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
3832
Documentation is available at [https://sail.dev/docs](https://sail.dev/docs/introduction/).
3933

4034
Or, you can read it in it's markdown form at [site/content/docs.](site/content/docs)
35+
36+
## Quick Start
37+
38+
### Requirements
39+
40+
**Currently Sail supports both Linux and MacOS. Windows support is planned for a future release.**
41+
42+
Before using Sail, there are several dependencies that must be installed on the host system:
43+
44+
- [Docker](https://docs.docker.com/install/)
45+
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
46+
- [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.
47+
If chrome is not installed, the default browser will be used.
48+
49+
50+
### Install
51+
52+
For simple, secure and fast installation, the following command will install the latest version
53+
of sail for your OS and architecture into `/usr/local/bin`. You will need to have `/usr/local/bin`
54+
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.
55+
56+
```
57+
curl https://sail.dev/install.sh | bash
58+
```
59+
60+
### Verify the Installation
61+
62+
To verify Sail is properly installed, run `sail --help` on your system. If everything is installed correctly, you should see Sail's help text.
63+
64+
### Run
65+
66+
You should now be able to run `sail run cdr/sail` from your terminal to start an environment designed for working
67+
on the Sail repo.
68+
69+
### Browser Extension
70+
71+
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/).
72+
73+
### Learn More
74+
75+
Additional docs covering concepts and configuration can be found at [https://sail.dev/docs](https://sail.dev/docs/introduction/).

0 commit comments

Comments
 (0)