README.md

   1 #deck.js
   2
   3 A JavaScript library for building modern HTML presentations. deck.js is flexible enough to let advanced CSS and JavaScript authors craft highly customized decks, but also provides templates and themes for the HTML novice to build a standard slideshow.
   4
   5 ## Quick Start
   6
   7 This repository includes a `boilerplate.html` as a starting point, with all the extensions included. Just [download it](https://github.com/imakewebthings/deck.js/archive/latest.zip), open `boilerplate.html`, and start editing your slides.
   8
   9 ## Documentation
  10
  11 Check out the [documentation page](http://imakewebthings.github.com/deck.js/docs) for more information on the methods, events, and options available in core and all the included extensions.  A sample standard slide deck is included in the package under the `introduction` folder.  You can also [view that sample deck](http://imakewebthings.github.com/deck.js/introduction) online to play with the available style and transition themes.
  12
  13 ## Extensions, Themes, and Related Projects
  14
  15 Take a look at [the wiki](https://github.com/imakewebthings/deck.js/wiki) for lists of extensions, themes, and other related goodies.  If you have a publicly available project of your own, feel free to add to the list.
  16
  17 ## Dependencies (included in this repository)
  18
  19 - [jQuery](http://jquery.com)
  20 - [Modernizr](http://modernizr.com)
  21
  22 ## Tests & Support
  23
  24 Unit tests are written with [Jasmine](http://jasmine.github.io/) and [jasmine-jquery](https://github.com/velesin/jasmine-jquery). You can [run them here](http://imakewebthings.github.com/deck.js/test).
  25
  26 deck.js has been tested with jQuery 1.6+ and works in IE7+, Chrome, FF, Safari, and Opera. The more capable browsers receive greater enhancements, but a basic cutaway slideshow will work for all browsers listed above. Please don't give your presentations in IE6.
  27
  28 For any questions or general discussion about deck.js please direct your attention to the [mailing list](http://groups.google.com/group/deckjs) (uses Google groups.)  If you would like to report a bug, please see the [issues page](https://github.com/imakewebthings/deck.js/issues).
  29
  30 ## Printing
  31
  32 Core includes stripped down black and white print styles for the standard slide template that is suitable for handouts.
  33
  34 ## Awesome Contributors
  35
  36 - [jbuck](https://github.com/jbuck)
  37 - [cykod](https://github.com/cykod)
  38 - [dougireton](https://github.com/dougireton)
  39 - [awirick](https://github.com/awirick)
  40 - Daniel Knittl-Frank
  41 - [alexch](https://github.com/alexch)
  42 - [twitwi](https://github.com/twitwi)
  43
  44 If you would like to contribute a patch to deck.js please do as much as you can of the following:
  45
  46 - Add or amend Jasmine tests.
  47 - Add inline documentation.
  48 - If the standard snippet of an extension changes, please change it in both the introduction deck and the snippet html in the extension folder.
  49 - If the API changes, it would be awesome to receive a parallel pull request to the gh-pages branch which updates the public-facing documentation.
  50
  51 ## License
  52
  53 Copyright (c) 2011-2014 Caleb Troughton
  54
  55 Licensed under the [MIT license](https://github.com/imakewebthings/deck.js/blob/master/MIT-license.txt)
  56
  57 ## Donations
  58
  59 [![Gittip donate
  60 button](http://img.shields.io/gittip/imakewebthings.png)](https://www.gittip.com/imakewebthings/ "Donate weekly to this project using Gittip")