Skip to content

Commit

Permalink
Update README.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
geraldb committed Jun 19, 2013
1 parent 3ddad6e commit 34e3856
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Slide Show (S9) Template Pack - Google HTML5 Rocks
# Google HTML5 Rocks - Slide Show (S9) Template Pack

## What's Slide Show (S9)?

A Ruby gem that lets you create slide shows and author slides in plain text
using a wiki-style markup language that's easy-to-write and easy-to-read.
More [Slide Show (S9) Project Site »](http://slideshow-s9.github.io)

## Intro

Google's [HTML5 Rocks Slides](https://github.com/html5rocks/www.html5rocks.com) code
bundled up into a Slide Show (S9) template pack (includes Moon, Sand and Sea Wave themes).
Expand All @@ -15,20 +23,25 @@ Note, the package is configured to use the following headers in `html5.html.erb`

If you want to try it yourself, install (fetch) the new template pack. Issue the command:

$ slideshow -f https://raw.github.com/slideshow-s9/slideshow-google-html5-slides/master/g5.txt
$ slideshow install g5

Or as an alternative clone the template pack using `git`. Issue the commands:

To check if the new template got installed, use the `-l/--list` switch/command:
$ cd ~/.slideshow/templates
$ git clone git://github.com/slideshow-s9/slideshow-google-html5-slides.git

$ slideshow -l
To check if the new template got installed, use the `list` command:

$ slideshow list

Listing something like:

Installed templates include:
g5.txt (/home/gerald/.slideshow/templates/g5/g5.txt)
g5.txt (~/.slideshow/templates/g5/g5.txt)

Now you're ready to use it using the `-t/--template` switch. Example:

$ slideshow -t g5.txt tutorial
$ slideshow build tutorial -t g5

That's it.

Expand All @@ -37,10 +50,3 @@ That's it.

Questions? Comments? 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).
Thanks!


## What's Slide Show (S9)?

A Ruby gem that lets you create slide shows and author slides in plain text
using a wiki-style markup language that's easy-to-write and easy-to-read.
More [Slide Show (S9) Project Site »](http://slideshow-s9.github.io)

0 comments on commit 34e3856

Please sign in to comment.