add readme

This commit is contained in:
Nicolas Hart 2015-10-05 13:54:01 +02:00
parent 58d271ec03
commit d9114eaac4
1 changed files with 45 additions and 0 deletions

45
README.md Normal file
View File

@ -0,0 +1,45 @@
# Glances website
## Installation
Install Bower :
```
npm install -g bower
```
Install Brunch :
```
npm install -g brunch
```
Install npm dependencies :
```
npm install
```
Install bower dependencies :
```
bower install
```
## Usage
All development assets files are in the `app` directory and are automatically built/copied into `public` directory by Brunch.
Run the following command before starting to code :
```
brunch watch
```
Or run this one for one shot build :
```
brunch build
```
## How to contribute ?
In order to optimize css and js files for production, always run the following command before push :
```
brunch build -P
```