Document bringing up the static layouts; rebuilding the styleguide
This commit is contained in:
parent
2c6891288e
commit
528f591f5a
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -1,5 +1,7 @@
|
||||||
# About the Agaric Pattern Library & Style Guide
|
# About the Agaric Pattern Library & Style Guide
|
||||||
|
|
||||||
|
This living styleguide is powered by the same styles as power the Agaric site itself. Changes in `agaric/sass/agaric/` will be reflected both in the styleguide and ultimately on the live sites, so be cautious!
|
||||||
|
|
||||||
## Set up
|
## Set up
|
||||||
|
|
||||||
#### Use the right version of node with:
|
#### Use the right version of node with:
|
||||||
|
@ -13,7 +15,17 @@ _This command will look at your `.nvmrc` file and use the version node.js specif
|
||||||
#### Install npm dependencies with
|
#### Install npm dependencies with
|
||||||
`npm install`
|
`npm install`
|
||||||
|
|
||||||
_This command looks at `package.json` and installs all the npm dependencies specified in it. Some of the dependencies include gulp, autoprefixer, gulp-sass and others._
|
_This command looks at `package.json` and installs all the npm dependencies specified in it. Some of the dependencies include grunt and grunt-sass._
|
||||||
|
|
||||||
|
### Rebuild the style guide
|
||||||
|
|
||||||
|
`grunt kss`
|
||||||
|
|
||||||
|
### Run the static design layouts
|
||||||
|
|
||||||
|
`grunt`
|
||||||
|
|
||||||
|
_This will open the static layouts in your browser. At the bottom you can click between them and to the style guide._
|
||||||
|
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue