Skip to content
This repository has been archived by the owner on Jul 11, 2022. It is now read-only.

Commit

Permalink
wip install option docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jason McCallister <jason@craftcms.com>
  • Loading branch information
jasonmccallister committed Mar 23, 2020
1 parent 79ec547 commit 609d034
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Nitro installs the following on every machine:

## Installation

There are two ways to install Nitro, global or per-project. Global installation will make the `nitro` executable available anywhere in your shell. Per-project installation is done through composer and places the `nitro` executable in your `/vendor/bin` directory.

### Composer

```shell script
composer require --dev craftcms/nitro
```
Expand All @@ -59,6 +63,22 @@ This will create a new machine with the default name `nitro-dev`. If you wish to
./vendor/bin/nitro --machine my-custom-name init
```

### Global

To install Nitro globally, visit the [releases page](https://github.com/pixelandtonic/nitro/releases) and download the binary for your Operating System.

- macOS is `darwin`
- Windows is `windows`
- Linux is `linux`

Unzip the downloaded file and place the `nitro` into your shell's path.

```bash
sudo mv /Users/jasonmccallister/Downloads/nitro_<VERSION>_darwin_x86_64/nitro /usr/local/bin/
```

TODO add windows manual instructions.

## Usage

In order to create a new development server, you must “initialize” Nitro. By default, this will not attach any directories and is equivalent to getting a brand new Virtual Private Server (VPS).
Expand Down

0 comments on commit 609d034

Please # to comment.