Skip to content

Commit

Permalink
Adds development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiopro committed Jan 8, 2017
1 parent 8741142 commit d9e430e
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,47 @@ Aoi _(Japanese: Blue, Green)_ is a design language for Emeraldion UX.

![Aoi banner](aoi_banner.png)

## Development

Aoi uses [Hologram](http://trulia.github.io/hologram), [Sass](http://sass-lang.com/) and [Gulp](http://gulpjs.com/). It manages dependencies with [Bundler](http://bundler.io/) and [NPM](https://www.npmjs.com). Node `>=6.9.3` and Ruby `>=2.4.0` are recommended.

### Clone the repo

```sh
git clone [email protected]:emeraldion/aoi.git
cd aoi
```

### Install dependencies

If you don't have `bundler` installed yet, install its gem:

```sh
gem install bundler
```

Install Ruby dependencies:

```sh
bundle
```

Then install Node dependencies:

```sh
npm install
```

### Build

Once you've installed everything, you can launch the Gulp build to generate CSS and the style guide:

```sh
npm start
```

Gulp will watch source files and generate the CSS and style guide using Hologram every time you save the sources.

## License

[MIT](https://opensource.org/licenses/MIT)
Expand Down

0 comments on commit d9e430e

Please sign in to comment.