2016-08-12 00:47:42 +03:00
# Shower Presentation Template [![Build Status](https://travis-ci.org/shower/shower.svg?branch=master)](https://travis-ci.org/shower/shower)
2015-12-13 06:09:18 +03:00
2015-12-24 18:25:34 +03:00
< img src = "pictures/logo.png" width = "250" alt = "Shower logo" >
2015-12-24 16:40:06 +03:00
2015-12-13 06:43:28 +03:00
> Shower ['ʃəuə] noun. A person or thing that shows.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
1. Built on HTML, CSS and vanilla JavaScript
2. Works in all modern browsers
3. Themes are separated from engine
2015-12-14 14:39:30 +03:00
4. Modular and extensible
5. Fully keyboard accessible
6. Printable to PDF
2015-12-13 06:09:18 +03:00
2015-12-13 06:54:34 +03:00
[See it in action ](http://shwr.me/ ). Includes [Ribbon ](https://github.com/shower/ribbon/ ) and [Material ](https://github.com/shower/material/ ) themes, and [core ](https://github.com/shower/core/ ) with plugins.
Follow [@shower_me ](https://twitter.com/shower_me ) for support and updates, [file an issue ](https://github.com/shower/shower/issues/new ) if you have any.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Quick Start
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
1. Download and unzip [template archive ](http://shwr.me/shower.zip )
2015-12-13 06:54:34 +03:00
2. Open `index.html` and start creating your presentation
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Advanced
2015-12-13 06:09:18 +03:00
2017-09-19 11:31:53 +03:00
1. Clone this repository locally `git clone git@github.com:shower/shower.git` .
2. [Create ](https://github.com/new ) a new blank repository and copy its cloning address `git@github.com:USER/REPO.git` .
3. Change remote of your local clone to the one you’ ve just copied `git remote set-url origin git@github.com:USER/REPO.git` .
4. Push your local clone to GitHub `git push -u origin master` .
6. Install dependencies `npm install` and start it `npm start` .
2015-12-13 06:09:18 +03:00
2016-04-03 21:03:55 +03:00
Once you’ re done you can build a clean copy of your slides:
npm run prepare
And you’ ll find your presentation in `prepared` folder with only needed files in it. You can also run `npm run archive` to get the same files in `archive.zip` . But there’ s more! You can easily publish your presentation online by running:
npm run publish
2017-09-19 11:31:53 +03:00
And you’ ll have your slides published to `http://USER.github.io/REPO/` .
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Usage Examples
2015-12-13 06:09:18 +03:00
2017-09-19 11:32:06 +03:00
- [Inhuman UI ](https://pepelsbey.net/pres/inhuman-ui/ )
- [My Vanilla CSS ](https://pepelsbey.net/pres/vanilla-css/ )
- [I’ m in IoT ](https://pepelsbey.net/pres/im-in-iot/ )
- [Enough Bricks ](https://pepelsbey.net/pres/enough-bricks/ )
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
## Browser Support
2015-12-13 06:09:18 +03:00
2018-02-07 06:24:27 +03:00
Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.
2015-12-13 06:09:18 +03:00
## Contributing
2015-12-13 06:43:28 +03:00
You’ re always welcome to contribute. Fork project, make changes and send it as pull request. But it’ s better to file an [issue ](https://github.com/shower/shower/issues ) with your idea first. Read [contributing rules ](CONTRIBUTING.md ) for more details.
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
Main contributors in historical order: [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 ), [zloylos ](https://github.com/zloylos ).
2015-12-13 06:09:18 +03:00
---
2015-12-13 06:43:28 +03:00
Licensed under [MIT License ](LICENSE.md ).