Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RnbWd committed Jun 3, 2016
1 parent 942fcbc commit 087f47d
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,19 @@ nut-bin
[![npm](https://img.shields.io/npm/v/nut-bin.svg?style=flat-square)](https://www.npmjs.com/package/nut-bin)
![License](https://img.shields.io/badge/licence-MIT-blue.svg?style=flat-square)

## How to install for windows / osx / linux

$ npm install -g nut-bin

## Info
> Nut: the development environment, containerized.
Full documentation can found in the main repo: https://github.com/matthieudelaro/nut
## Installation

> Nut: the development environment, containerized.
$ npm install -g nut-bin

$ nut --init # create nut.yml file (equivalent of package.json for npm)
$ nut build
$ nut run
$ nut test

Full documentation can found in the main repo: https://github.com/matthieudelaro/nut

**Nut** mounts the current folder in a [Docker](https://www.docker.com/) container, and executes commands on your behalf, according to the project configuration. The configuration is read from `nut.yml` file, in the current folder. You can choose the Docker image to use, declare volumes to mount, and define commands (called macros) such as *build*, *run*, and *test*.

Nut is in early stage of development. It has been tested on Ubuntu and on MacOS with *Docker for Mac*. Feedbacks and contributions to add features and to make Nut run on other systems are welcome (Windows, Docker Toolbox, etc).
Expand Down

0 comments on commit 087f47d

Please sign in to comment.