Permalink
Browse files

update readme

  • Loading branch information...
geraldb committed Jun 27, 2010
1 parent 97c792e commit 5e609ac1e35fc2627801cde7ffd2081a34891e03
Showing with 35 additions and 1 deletion.
  1. +35 −1 README.markdown
View
@@ -1,8 +1,42 @@
## Slide Show (S9) Template Pack - S5 Blank
+The [S5 Blank](http://meyerweb.com/eric/tools/s5/) package bundled up into
+a Slide Show (S9) template pack.
+Note, the package is configured to use the following headers in `slides.html.erb`:
+ author: Your Name Here
+ company: Your Company Here
+ title: Your Slide Show Title Here
+ subtitle: Your Subtitle Here
+ footer: Your Footer Here
+ subfooter: Your Subfooter Here
+
+See the original [S5: An Introduction](http://meyerweb.com/eric/tools/s5/s5-intro.html) slides in action or
+see the [Slide Show (S9) Tutorial](http://slideshow.rubyforge.org/s5/tutorial.html)
+slides generated using this template pack.
+
+
+## Try It Yourself - How To Use the Template Pack
+
+If you want to try it yourself, install (fetch) the new template pack. Issue the command:
+
+ $ slideshow -f http://github.com/geraldb/slideshow-s5-blank/raw/master/s5blank.txt
+
+To check if the new template got installed, use the `-l/--list` switch/command:
+
+ $ slideshow -l
+
+Listing something like:
+
+ Installed templates include:
+ s5blank.txt (/home/gerald/.slideshow/templates/s5blank/s5blank.txt)
+
+Now you're ready to use it using the `-t/--template` switch. Example:
+
+ $ slideshow -t s5blank.txt tutorial
+That's it.
@@ -26,7 +60,7 @@ and than move the souces into your templates folder (that is, `~/.slideshow/temp
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!
-## Appendix: Sample Slide Show in Textile
+## Appendix: Sample Slide Show Source in Textile
author: Your Name Here
company: Your Company Here

0 comments on commit 5e609ac

Please sign in to comment.