Mercurial > hg > Members > atton > slideshow-s6cr

annotate README.markdown @ 3:da1255a82e3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README
author Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
date Mon, 21 Dec 2015 22:32:22 +0900
parents d2082b552de6
children b71918a78849
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
1 # s6cr - Slide Show (S9) Template Pack
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 ## What's Slide Show (S9)?
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
4
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
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
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
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.
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
7 More [Slide Show (S9) Project Site](http://slideshow-s9.github.io)
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
8
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 ## Intro
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
10
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
11 Note, the package is configured to use the following headers in `slides.html.erb`:
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
12
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
13 author: Your Name Here
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
14 title: Your Slide Show Title Here
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
15 profile: Your Profile Here
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
16 lang: Your Language Here
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
17
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 ## Try It Yourself - How To Use the Template Pack
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
19
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
20 If you want to try it yourself, clone the template pack using `hg`. Issue the commands:
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
21
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
22 $ cd ~/.slideshow/templates
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
23 $ hg clone ssh://firefly.cr.ie.u-ryukyu.ac.jp/~one/hg/Members/atton/slideshow-s6cr
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
24
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
25 To check if the new template got installed, use the `list` command:
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
26
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 $ slideshow list
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
28
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 Listing something like:
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
30
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
31 Installed templates include:
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
32 s6cr.txt (~/.slideshow/templates/slideshow-cr/s6cr.txt)
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
33
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
34 Now you're ready to use it using the `-t/--template` switch. Example:
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
35
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
36 $ slideshow build tutorial -t s6cr
0
d2082b552de6 Import from https://github.com/slideshow-templates/slideshow-s6-blank (0d3a84f)
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents:
diff changeset
37
3
da1255a82e3c Update README
Yasutaka Higa <e115763@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
38 That's it.