agaric/patternlibrary
10
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Put more info into README

Browse source
This commit is contained in:
benjamin melançon 2018-08-20 09:53:31 -04:00
parent 952af16725
commit 55bc8d67ca
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,3 +1,24 @@
# Readme
# About the Agaric Pattern Library & Style Guide
See `styleguide/index.html` for project info.
## 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.