From 528f591f5ad9609d04941ad0d6b1bc7b403e36b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?benjamin=20melan=C3=A7on?= Date: Tue, 21 Aug 2018 18:12:49 -0400 Subject: [PATCH] Document bringing up the static layouts; rebuilding the styleguide --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e1c499d..f01831c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # 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 #### 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 `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