ivan-igorevich
/
bmstu-mt-wp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewritten readme

This commit is contained in:
Vadim Makeev 2012-12-03 03:21:21 +04:00
parent fd4e4a3d47
commit 1281d2513e
1 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Readme.md
View File

@ -1,28 +1,32 @@
# Shower
Сross-browser presentation template.
Presentation engine. Follow [@shower_me](http://twitter.com/shower_me/) for support and updates.
To see Shower in action:
- Open [shwr.me](http://shwr.me/)
- Click any slide to enter presentation mode
- Use arrow keys to navigate
- Press `Esc` to exit presentation mode
See more details on how to use only keyboard to navagate [in documentation](shower/wiki/Shortcuts).
See more details on [using keyboard](shower/wiki/Shortcuts) to control Shower.
Follow [@shower_me](http://twitter.com/shower_me/) on Twitter for support and updates.
## Using Shower
## Supported Browsers
There are two ways of getting Shower: you can get full template or just an engine.
- Desktop platforms: Chrome, Firefox, Opera, Safari
To get full [template](https://github.com/shower/template) run following command:
Only latest stable versions of mentioned browsers are supported.
```
git clone --recursive git@github.com:shower/template.git
```
## Planned Support
To get only [shower](https://github.com/shower/shower) engine, run this:
- Desktop platforms: IE10
- Mobile platforms: Mobile Safari, Opera Mobile
Please address bugs and your suggestions to [Issues](http://github.com/pepelsbey/shower/issues).
```
git clone --recursive git@github.com:shower/shower.git
```
Or you can just download latest version as ZIP file: [template](https://github.com/downloads/shower/template/template.zip) and [shower](https://github.com/downloads/shower/shower/shower.zip).
## Usage examples
@ -34,4 +38,20 @@ Please address bugs and your suggestions to [Issues](http://github.com/pepelsbey
- [Sense Coding](http://pepelsbey.net/pres/sense-coding/)
- [Dynamic Graphics](http://pepelsbey.net/pres/dynamic-graphics/)
## Supported Browsers
Desktop platforms: Chrome, Internet Explorer 10, Firefox, Opera, Safari.
Only latest stable versions of mentioned browsers are supported.
## Planned Support
Mobile platforms: Chrome, Firefox, Safari, Opera Mobile.
## Contributing
You're always welcome to contibute. Fork project, make changes and send it as pull request. But it's better to file an [issue](http://github.com/shower/shower/issues) first.
Main contributors: @pepelsbey, @jahson, @miripiruni, @kizu.
Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](shower/wiki/MIT-License) for details.