bmstu-mt-wp/Readme.md

57 lines
2.8 KiB
Markdown
Raw Normal View History

# Shower HTML presentation engine
2012-12-01 14:37:49 +04:00
Follow [@shower_me](https://twitter.com/shower_me) for support and updates
2012-12-03 03:21:21 +04:00
To see Shower in action:
2012-12-01 14:37:49 +04:00
- Open [shwr.me](http://shwr.me/)
- Click any slide to enter presentation mode
- Use arrow keys or presenter remote to navigate
- Press `Esc` to exit presentation mode
2012-12-01 14:37:49 +04:00
2014-03-20 19:08:04 +04:00
See [Wiki](https://github.com/shower/shower/wiki) for more information how to use Shower.
2012-12-01 14:37:49 +04:00
## Using Shower
2012-12-01 14:37:49 +04:00
2014-03-20 19:08:04 +04:00
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](https://www.npmjs.org) or [bower](http://bower.io).
2012-12-07 17:22:34 +04:00
2014-03-20 19:08:04 +04:00
## Simple Way
2012-12-07 17:22:34 +04:00
2014-03-20 19:08:04 +04:00
In a simple way you just download the latest Shower version with built-in themes and use it.
2014-03-20 19:08:04 +04:00
1. Download and unarchive [shower.zip](http://shwr.me/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
2014-03-20 19:08:04 +04:00
## Module Way
2014-03-20 19:08:04 +04:00
Module way allows you to manually install needed Shower packages and requires [Git](http://git-scm.com/) and [Node.js](http://nodejs.org/) installed together with package managment system: `npm` or `bower`.
2014-03-20 19:08:04 +04:00
1. Clone Shower `git clone git@github.com:shower/shower.git` or download [shower-pkg.zip](http://shwr.me/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
2012-12-01 14:37:49 +04:00
## Usage examples
- [Clear and Sharp](http://pepelsbey.net/pres/clear-and-sharp/)
- [CSS Management](http://pepelsbey.net/pres/knife-train/)
2012-12-01 14:37:49 +04:00
- [Push it!](http://pepelsbey.net/pres/push-it/)
- [Pre-fixes](http://pepelsbey.net/pres/pre-fixes/)
- [Web In Curves](http://pepelsbey.net/pres/web-in-curves/)
- [Sense Coding](http://pepelsbey.net/pres/sense-coding/)
2012-12-07 17:22:34 +04:00
## Browser support
2012-12-03 03:21:21 +04:00
Latest stable versions of Chrome, Internet Explorer, Firefox, Opera and Safari are supported.
2012-12-03 03:21:21 +04:00
## Contributing
Youre always welcome to contibute. Fork project, make changes and send it as pull request. But its better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](https://github.com/shower/shower/blob/master/Contributing.md) for more details.
2012-12-03 03:21:21 +04:00
Main contributors: [pepelsbey](https://github.com/pepelsbey), [jahson](https://github.com/jahson), [miripiruni](https://github.com/miripiruni), [kizu](https://github.com/kizu), [artpolikarpov](https://github.com/artpolikarpov), [tonyganch](https://github.com/tonyganch).
2012-12-03 03:21:21 +04:00
2012-12-03 03:57:01 +04:00
---
Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](https://github.com/shower/shower/wiki/MIT-License) for details.