lychee/docs/Build.md

26 lines
832 B
Markdown
Raw Normal View History

2014-02-23 15:59:45 +00:00
### Dependencies
First you have to install the following dependencies:
2014-04-01 20:03:43 +00:00
- `node` [Node.js](http://nodejs.org) v0.10 or later
- `npm` [Node Packaged Modules](https://www.npmjs.org)
- `bower` [Bower](http://bower.io)
2014-07-18 20:15:37 +00:00
- `gulp` [Gulp.js](http://gulpjs.com)
2014-02-23 15:59:45 +00:00
2014-04-28 18:41:13 +00:00
After [installing Node.js](http://nodejs.org) you can use the included `npm` package manager to install the global requirements and Lychee-dependencies with the following command:
2014-02-23 15:59:45 +00:00
2014-07-18 20:15:37 +00:00
cd build/;
npm install -g bower gulp;
2014-04-28 18:41:13 +00:00
npm install && bower install;
2014-07-18 20:15:37 +00:00
2014-02-23 15:59:45 +00:00
### Build
2014-07-18 20:15:37 +00:00
The Gruntfile is located in `build/` and can be easily executed using the `gulp` command.
2014-02-23 15:59:45 +00:00
2014-04-01 20:03:43 +00:00
### Watch for changes
While developing, you might want to use the following command to watch for changes in `assets/js/` and `assets/css/`:
2014-02-23 15:59:45 +00:00
2014-07-18 20:15:37 +00:00
gulp watch
2014-04-01 20:03:43 +00:00
2014-07-18 20:15:37 +00:00
`gulp` will automatically build Lychee everytime you save a file.