From: Hakim El Hattab Date: Sat, 4 May 2013 17:38:02 +0000 (-0300) Subject: setup instructions #357 X-Git-Tag: 2.4.0~2^2~1 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5132ccd26d6f62a047246bcc0f03192a30d1952e;p=reveal.js.git setup instructions #357 --- diff --git a/README.md b/README.md index 4ce6a94..da44fcf 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ A framework for easily creating beautiful presentations using HTML. [Check out t reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere. -#### More reading in the Wiki: +#### More reading:: +- [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer. - [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history. - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own! - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks. @@ -408,11 +409,46 @@ Each theme is available as a separate stylesheet. To change theme you will need If you want to add a theme of your own see the instructions here: [/css/theme/README.md](https://github.com/hakimel/reveal.js/blob/master/css/theme/README.md). -## Development Environment +## Installation -reveal.js is built using the task-based command line build tool [grunt.js](http://gruntjs.com) ([installation instructions](http://gruntjs.com/getting-started#installing-the-cli)). With Node.js and grunt.js 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. +The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features as well as the development tasks needed to make changes to the source. + +### Basic setup + +The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.g + +1. Download a copy of reveal.js from + +2. Unizp and replace the example contents in index.html with your own + +3. Open index.html in a browser to view it + + +### Full setup + +Some reveal.js features, like external markdown, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code. + +1. Install [Node.js](http://nodejs.org/) + +2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli) + +4. Clone the reveal.js repository +``` +$ git clone git@github.com:hakimel/reveal.js.git +``` + +5. Install dependencies +``` +$ npm install +``` + +6. Serve the presentation and monitor source files for changes +``` +$ grunt serve +``` + +7. Open to view your presentation -If you want to customise 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