add grunt.js build file (closes #235)

This commit is contained in:
Hakim El Hattab 2012-11-11 10:01:05 -05:00
parent 8e79f8592a
commit d6d0f40c5e
7 changed files with 150 additions and 124 deletions

View file

@ -285,12 +285,19 @@ Then:
3. Run ```node plugin/notes-server```
## Folder Structure
## Development Environment
reveal.js is built using the task-based command line build tool (grunt.js)[http://gruntjs.com]. Installation instructions here https://github.com/gruntjs/grunt#installing-grunt. With Node.js and grunt installed, you need to start by running ```npm install``` in the reveal.js root. When the dependencies have been installed you should run ```grunt watch``` to start monitoring files for changes.
If you want to customize reveal.js without running grunt.js you can alter the HTML to point to the uncompressed source files (css/reveal.css/js/reveal.js).
### Folder Structure
- **css/** Core styles without which the project does not function
- **js/** Like above but for JavaScript
- **plugin/** Components that have been developed as extensions to reveal.js
- **lib/** All other third party assets (JavaScript, CSS, fonts)
## License
MIT licensed