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/zipball/stable), 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://pivotal.github.com/jasmine/) 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 ## Known Bug(s)
  31
  32 There is an issue with certain builds of Chrome that result in a solid blue background and generally broken decks.  This is a bug in Chrome ([Issue 91518](http://code.google.com/p/chromium/issues/detail?id=91518)) that stems from hardware acceleration of 3d transforms.  Current workarounds:
  33
  34 - Use a different browser. This problem doesn't exist in Safari, FF, Opera.
  35 - Disable hardware compositing by setting `--disable-accelerated-compositing` in the Chrome loading options
  36 - Replace instances of `translate3d` with `translate` in the CSS of your decks (though this will slow down performance on iOS devices and Safari.)
  37
  38 Firefox contains a bug that allows users to scroll horizontally using the trackpad despite `overflow-x:hidden`. ([Bug 664275](https://bugzilla.mozilla.org/show_bug.cgi?id=664275) and [Bug 325942](https://bugzilla.mozilla.org/show_bug.cgi?id=325942).) If anyone knows of any workarounds to this issue please contact me.
  39
  40 ## Printing
  41
  42 Core includes stripped down black and white print styles for the standard slide template that is suitable for handouts.
  43
  44 ## Awesome Contributors
  45
  46 - [jbuck](https://github.com/jbuck)
  47 - [cykod](https://github.com/cykod)
  48 - [dougireton](https://github.com/dougireton)
  49 - [awirick](https://github.com/awirick)
  50 - Daniel Knittl-Frank
  51 - [alexch](https://github.com/alexch)
  52
  53 If you would like to contribute a patch to deck.js please do as much as you can of the following:
  54
  55 - Add or amend Jasmine tests.
  56 - Add inline documentation.
  57 - If the standard snippet of an extension changes, please change it in both the introduction deck and the snippet html in the extension folder.
  58 - 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.
  59
  60 ## License
  61
  62 Copyright (c) 2011-2012 Caleb Troughton
  63
  64 Dual licensed under the [MIT license](https://github.com/imakewebthings/deck.js/blob/master/MIT-license.txt) and [GPL license](https://github.com/imakewebthings/deck.js/blob/master/GPL-license.txt).