From 55bc8d67cadc642fa4e8f9398ee9d53a286a1d10 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?benjamin=20melan=C3=A7on?= Date: Mon, 20 Aug 2018 09:53:31 -0400 Subject: [PATCH] Put more info into README --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8de7ffd..db3e16b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,24 @@ -# Readme +# About the Agaric Pattern Library & Style Guide -See `styleguide/index.html` for project info. \ No newline at end of file +## Set up + +#### Use the right version of node with: +`nvm use` + +_This command will look at your `.nvmrc` file and use the version node.js specified in it. This ensures all developers use the same version of node for consistency._ + +#### If that version of node isn't installed, install it with: +`nvm install` + +#### 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._ + +## Contents + +The `agaric` folder contains + +### Markup examples and static layouts + +See `styleguide/index.html` for project info.