From d6d0f40c5ec3871b6ae25f3552b48d04db84c41a Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Sun, 11 Nov 2012 10:01:05 -0500 Subject: add grunt.js build file (closes #235) --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 91bc452..972ef0d 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3