Go to file
Vadim Makeev 6a89cd8db4 New contributing guide 2015-12-13 06:43:18 +03:00
pictures Now this repository is rather template. Shower.js is moved to core repo 2014-03-08 22:46:15 +04:00
.editorconfig Two spaces for JSON and YML, trailing /n 2014-05-18 23:45:59 +02:00
.gitignore New ignores 2014-09-14 19:53:36 +02:00
.npmignore Uppercase excludes 2015-12-13 06:07:02 +03:00
CONTRIBUTING.md New contributing guide 2015-12-13 06:43:18 +03:00
Gruntfile.js New archive task for Grunt 2014-05-27 13:02:58 +02:00
LICENSE.md Year bump 2015-12-13 06:43:02 +03:00
README.md Uppercase’s back 2015-12-13 06:09:18 +03:00
bower.json Bright replaced with Material 2015-12-13 06:07:27 +03:00
index.html Shower 2.0 compatible HTML, bumped year 2015-12-06 19:43:13 +01:00
package.json Bright replaced with Material 2015-12-13 06:07:27 +03: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 about 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

Advanced Way

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

  1. Run npm install shower-core shower-ribbon
  2. Link core and theme files in node_modules folder to your presentation file
  3. You probably know what to do next, its an advanced way

Note: you can use bower instead of npm or shower-bright instead of shower-ribbon in command above to install Shower using Bower or get Bright theme.

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.