comparison README.markdown @ 3:da1255a82e3c

Update README
author Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
date Mon, 21 Dec 2015 22:32:22 +0900
parents d2082b552de6
children b71918a78849
comparison
equal deleted inserted replaced
2:5f64409dd886 3:da1255a82e3c
1 # S6 Blank - Slide Show (S9) Template Pack 1 # s6cr - Slide Show (S9) Template Pack
2 2
3 ## What's Slide Show (S9)? 3 ## What's Slide Show (S9)?
4 4
5 A Ruby gem that lets you create slide shows and author slides in plain text 5 A Ruby gem that lets you create slide shows and author slides in plain text
6 using a wiki-style markup language that's easy-to-write and easy-to-read. 6 using a wiki-style markup language that's easy-to-write and easy-to-read.
7 More [Slide Show (S9) Project Site ยป](http://slideshow-s9.github.io) 7 More [Slide Show (S9) Project Site](http://slideshow-s9.github.io)
8 8
9 ## Intro 9 ## Intro
10 10
11 The [S6 Blank](https://github.com/geraldb/s6) package bundled up into 11 Note, the package is configured to use the following headers in `slides.html.erb`:
12 a Slide Show (S9) template pack.
13 12
14 Note, this template pack includes **no** vector graphics gradient themes "out-of-the-box". 13 author: Your Name Here
15 The background is blank (white) and the text color is black. 14 title: Your Slide Show Title Here
16 Change the background and colors to your need. 15 profile: Your Profile Here
17 16 lang: Your Language Here
17
18 ## Try It Yourself - How To Use the Template Pack 18 ## Try It Yourself - How To Use the Template Pack
19 19
20 If you want to try it yourself, install (fetch) the new template pack. Issue the command: 20 If you want to try it yourself, clone the template pack using `hg`. Issue the commands:
21
22 $ slideshow install s6blank
23
24 Or as an alternative clone the template pack using `git`. Issue the commands:
25 21
26 $ cd ~/.slideshow/templates 22 $ cd ~/.slideshow/templates
27 $ git clone git://github.com/slideshow-s9/slideshow-s6-blank.git 23 $ hg clone ssh://firefly.cr.ie.u-ryukyu.ac.jp/~one/hg/Members/atton/slideshow-s6cr
28 24
29 To check if the new template got installed, use the `list` command: 25 To check if the new template got installed, use the `list` command:
30 26
31 $ slideshow list 27 $ slideshow list
32 28
33 Listing something like: 29 Listing something like:
34 30
35 Installed templates include: 31 Installed templates include:
36 s6blank.txt (~/.slideshow/templates/s6blank/s6blank.txt) 32 s6cr.txt (~/.slideshow/templates/slideshow-cr/s6cr.txt)
37 33
38 Now you're ready to use it using the `-t/--template` switch. Example: 34 Now you're ready to use it using the `-t/--template` switch. Example:
39 35
40 $ slideshow build tutorial -t s6blank 36 $ slideshow build tutorial -t s6cr
41 37
42 That's it. 38 That's it.
43
44
45 ## Questions? Comments?
46
47 Questions? Comments?
48 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).
49 Thanks!