lychee/docs/Build.md

26 lines
737 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)
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
cd src/
2015-07-06 15:07:46 +00:00
npm install -g gulp
npm install
2014-07-18 20:15:37 +00:00
2014-02-23 15:59:45 +00:00
### Build
2015-07-06 15:07:46 +00:00
The Gulpfile is located in `src/` and can be easily executed using the `gulp` command.
2014-10-10 21:30:10 +00:00
2014-04-01 20:03:43 +00:00
### Watch for changes
2014-10-10 21:30:10 +00:00
While developing, you might want to use the following command to watch for changes:
2014-02-23 15:59:45 +00:00
2014-07-18 20:15:37 +00:00
gulp watch
2014-10-10 21:30:10 +00:00
2015-07-06 15:07:46 +00:00
`gulp watch` will automatically build Lychee everytime you save a file.