Update readme.md

This commit is contained in:
Chris Williams
2016-02-19 12:07:19 -08:00
parent f40c024fda
commit 0eb3dcd81f

View File

@@ -9,14 +9,28 @@ managed with npm.
Using npm to generate bundled files
-----------------------------------
To install third party libraries defined in package.json, run the following within this directory
#### npm
First, npm must be available in your environment. If it is not you can run the following commands
(taken from [this source](https://gist.github.com/DanHerbert/9520689))
```
brew install node --without-npm
echo prefix=~/.npm-packages >> ~/.npmrc
curl -L https://www.npmjs.com/install.sh | sh
```
The final step is to add ```~/.node/bin``` to your ```PATH``` so commands you install globally are usable. Add something like this to your ```.bashrc``` or ```.zshrc``` file.
```
export PATH="$HOME/.node/bin:$PATH"
```
#### npm packages
To install third party libraries defined in ```package.json```, run the following within this directory which will install them in a new ```node_modules/``` folder within ```assets/```.
```
npm install
```
To parse and generate bundled files, run either of the following. The dev flag will keep the npm script running
and re-run upon any changes within the dev directory
To parse and generate bundled files for panoramix, run either of the following commands. The ```dev``` flag will keep the npm script running and re-run it upon any changes within the assets directory.
```
npm run prod