annotate README.markdown @ 0:7ebef75a44eb

Import from https://github.com/slideshow-s9/slideshow-shower
author Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
date Sat, 15 Nov 2014 14:44:31 +0900 (2014-11-15)
parents
children eb5b2d692b34
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 # Shower (Ribbon Theme) - Slide Show (S9) Template Pack
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 ## What's Slide Show (S9)?
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
4
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 A Ruby gem that lets you create slide shows and author slides in plain text
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
6 using a wiki-style markup language that's easy-to-write and easy-to-read.
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 More [Slide Show (S9) Project Site »](http://slideshow-s9.github.io)
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
8
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 ## Intro
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
10
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 The [Shower](https://github.com/shower/shower) package by Vadim Makeev bundled up into
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 a Slide Show (S9) template pack.
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
13
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 Note, the package is configured to use the following headers in `slides.html.erb`:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
15
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
16 author: Your Name Here
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
17 title: Your Slide Show Title Here
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 cover: Your Slide Show Cover Image Here
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
19 lang: Your Language Here
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
20
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
21 ## Try It Yourself - How To Use the Template Pack
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
22
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
23 If you want to try it yourself, install (fetch) the new template pack. Issue the command:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
24
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
25 $ slideshow install shower
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
26
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 Or as an alternative clone the template pack using `git`. Issue the commands:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
28
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 $ cd ~/.slideshow/templates
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
30 $ git clone git://github.com/slideshow-s9/slideshow-shower.git
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
31
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
32 To check if the new template got installed, use the `list` command:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
33
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
34 $ slideshow list
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
35
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
36 Listing something like:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
37
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
38 Installed templates include:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
39 shower.txt (~/.slideshow/templates/shower/shower.txt)
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
40
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
41 Now you're ready to use it using the `-t/--template` switch. Example:
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
42
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
43 $ slideshow build tutorial -t shower
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
44
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
45 That's it.
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
46
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
47 ## Questions? Comments?
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
48
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
49 Questions? Comments?
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
50 Send them along to the [Free Web Slide Show Alternatives (S5, S6, S9, Slidy And Friends) Forum/Mailing List](http://groups.google.com/group/webslideshow).
7ebef75a44eb Import from https://github.com/slideshow-s9/slideshow-shower
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 Thanks!