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

Better usage section linked to updated Quick Start

This commit is contained in:
Vadim Makeev 2012-12-19 06:35:05 +04:00
parent 335199d95a
commit 5f6c7383dc
1 changed files with 5 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Readme.md
View File

@ -9,31 +9,17 @@ To see Shower in action:
- Use arrow keys to navigate
- Press `Esc` to exit presentation mode
See more details on [using keyboard](shower/wiki/Shortcuts) to control Shower.
See more details on [using keyboard](wiki/Shortcuts) to control Shower.
## Taking Shower
## Using Shower
There are two ways of taking Shower: you can get full template or just an engine.
To get full [template](https://github.com/shower/template) based on [shower](https://github.com/shower/shower) engine and [ribbon](https://github.com/shower/ribbon) theme run following command:
```
git clone --recursive git@github.com:shower/template.git
```
To get only [shower](https://github.com/shower/shower) engine including [ribbon](https://github.com/shower/ribbon) theme, run this:
```
git clone --recursive git@github.com:shower/shower.git
```
Or you can just download latest version as ZIP file: [template](http://shwr.me/template.zip) or [shower](http://shwr.me/shower.zip).
There are two ways of using Shower: you can get full template [ZIP 3.5 MB](http://shwr.me/template.zip) or just an engine [ZIP 2.7 MB](http://shwr.me/shower.zip). See more details for beginners and advanced techniques in [Quick Start](wiki/Quick-Start) instructions.
## Printing to PDF
You can print your presentation to PDF using Google Chrome “Print to PDF” option in print dialog, [wkhtmltopdf](http://code.google.com/p/wkhtmltopdf) or [Prince](http://princexml.com). Print styles should be supplied to a theme for proper results. Please see [print styles](https://github.com/shower/ribbon/blob/master/styles/print.scss) for the Ribbon theme as example.
Example of Shower template printed by Prince: [PDF 435 KB](https://github.com/shower/template/blob/master/index.pdf?raw=true). See more detais on printing in [documentation](https://github.com/shower/shower/wiki/Print).
Example of Shower template printed by Prince: [PDF 435 KB](https://github.com/shower/template/blob/master/index.pdf?raw=true). See more detais on printing in [documentation](wiki/Print).
## Usage examples
@ -56,4 +42,4 @@ You're always welcome to contibute. Fork project, make changes and send it as pu
Main contributors: [pepelsbey](http://github.com/pepelsbey), [jahson](http://github.com/jahson), [miripiruni](http://github.com/miripiruni), [kizu](http://github.com/kizu).
---
Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](shower/wiki/MIT-License) for details.
Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](wiki/MIT-License) for details.