Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #689 from nclsHart/gh-pages-readme
[gh-pages] add readme
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |