bmstu-mt-wp/README.md

46 lines
2.3 KiB
Markdown
Raw Normal View History

2015-12-13 06:43:28 +03:00
# Shower Presentation Template
2015-12-13 06:09:18 +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
4. Fully keyboard accessible
5. Printable to PDF
6. Extensible by plugin system
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/core/) with plugins. [See it in action](http://shwr.me/). 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)
2. Open `index.html` and start creating your presentation in HTML
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
2015-12-13 06:43:28 +03:00
If youre familiar with [npm](https://www.npmjs.com/) you can install Showers core and themes manually: `npm install shower-core shower-ribbon`. The same packages available in [bower](http://bower.io/).
2015-12-13 06:09:18 +03:00
2015-12-13 06:43:28 +03:00
For more details see short [video](https://www.youtube.com/watch?v=l2OelK_hIro) with advanced usage examples and built-in `publish` and `archive` commands explained.
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
- [Clear and Sharp](http://pepelsbey.net/pres/clear-and-sharp/)
- [CSS Management](http://pepelsbey.net/pres/knife-train/)
- [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/)
2015-12-13 06:43:28 +03:00
## Browser Support
2015-12-13 06:09:18 +03:00
Latest stable versions of Chrome, Internet Explorer, Firefox, Opera and Safari are supported.
## Contributing
2015-12-13 06:43:28 +03:00
Youre always welcome to contribute. 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](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).