Go to file
Vadim Makeev 345f08ae9d Bump for quick releases 2014-03-21 12:40:34 +04:00
pictures Now this repository is rather template. Shower.js is moved to core repo 2014-03-08 22:46:15 +04:00
.editorconfig Bower config 2014-03-14 19:50:34 +04:00
.gitignore New build and test system 2013-12-01 10:05:34 +04:00
.npmignore Bower config 2014-03-14 19:50:34 +04:00
Contributing.md Updated contributing rules 2014-03-10 16:22:05 +04:00
License.md Russian translation reverted; Markdown goodness 2013-01-29 03:19:53 +04:00
Readme.md Depth 1 for quicker clone 2014-03-21 12:38:31 +04:00
bower.json Updating dependencies; bumping up version 2014-03-20 22:28:45 +04:00
index.html Now this repository is rather template. Shower.js is moved to core repo 2014-03-08 22:46:15 +04:00
package.json Bump for quick releases 2014-03-21 12:40:34 +04:00

Readme.md

Shower HTML presentation engine

Follow @shower_me for support and updates

To see Shower in action:

  • Open shwr.me
  • Click any slide to enter presentation mode
  • Use arrow keys or presenter remote to navigate
  • Press Esc to exit presentation mode

See Wiki for more information how to use Shower.

Using Shower

There are two ways of making presentation using Shower: you can just download an archive with all you need or you can install needed Shower modules using npm or bower.

Simple Way

In a simple way you just download the latest Shower version with built-in themes and use it.

  1. Download and unarchive shower.zip
  2. Open index.html in any code or text editor, edit your slides in HTML
  3. Use pictures folder for pictures used in presentation
  4. Once finished, open index.html in a browser, enter full screen and start presenting

Module Way

Module way allows you to manually install needed Shower packages and requires Git and Node.js installed together with package managment system: npm or bower.

  1. Clone Shower git clone git@github.com:shower/shower.git --depth 1 or download shower-pkg.zip
  2. Run npm install (or bower install) command in resulted folder to install script and themes
  3. Open index.html in any code or text editor, edit your slides in HTML
  4. Use pictures folder for pictures used in presentation
  5. Once finished, open index.html in browser, enter full screen and start presenting

Usage examples

Browser support

Latest stable versions of Chrome, Internet Explorer, Firefox, Opera and Safari are supported.

Contributing

Youre always welcome to contibute. Fork project, make changes and send it as pull request. But its better to file an issue with your idea first. Read contributing rules for more details.

Main contributors: pepelsbey, jahson, miripiruni, kizu, artpolikarpov, tonyganch.


Licensed under MIT License, see license page for details.