Mercurial > hg > Members > anatofuz > slideshow-s6cr
changeset 17:71da5aeed0ee
rename REAME.markdown for README.md
author | Takahiro SHIMIZU <anatofuz@cr.ie.u-ryukyu.ac.jp> |
---|---|
date | Wed, 17 Oct 2018 12:38:16 +0900 |
parents | 99b0c852c07a |
children | b2278b4def24 |
files | README.markdown README.md |
diffstat | 2 files changed, 43 insertions(+), 43 deletions(-) [+] |
line wrap: on
line diff
--- a/README.markdown Wed Oct 17 12:37:16 2018 +0900 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,43 +0,0 @@ -# s6cr - 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 - -Note, the package is configured to use the following headers in `slides.html.erb`: - - author: Your Name Here - title: Your Slide Show Title Here - profile: Your Profile Here - lang: Your Language Here - -## Try It Yourself - How To Use the Template Pack - -If you want to try it yourself, clone the template pack using `hg`. Issue the commands: - - $ cd ~/.slideshow/templates - $ hg clone ssh://firefly.cr.ie.u-ryukyu.ac.jp/~one/hg/Members/anatofuz/slideshow-s6cr - -To check if the new template got installed, use the `list` command: - - $ slideshow list - -Listing something like: - - Installed templates include: - s6cr.txt (~/.slideshow/templates/slideshow-cr/s6cr.txt) - -Now you're ready to use it using the `-t/--template` switch. Example: - - $ slideshow build tutorial -t s6cr - -That's it. - - -## PDF generation - - $ wkhtmltopdf --outline --orientation Landscape slide.pdf.html slide.pdf
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Wed Oct 17 12:38:16 2018 +0900 @@ -0,0 +1,43 @@ +# s6cr - 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 + +Note, the package is configured to use the following headers in `slides.html.erb`: + + author: Your Name Here + title: Your Slide Show Title Here + profile: Your Profile Here + lang: Your Language Here + +## Try It Yourself - How To Use the Template Pack + +If you want to try it yourself, clone the template pack using `hg`. Issue the commands: + + $ cd ~/.slideshow/templates + $ hg clone ssh://firefly.cr.ie.u-ryukyu.ac.jp/~one/hg/Members/anatofuz/slideshow-s6cr + +To check if the new template got installed, use the `list` command: + + $ slideshow list + +Listing something like: + + Installed templates include: + s6cr.txt (~/.slideshow/templates/slideshow-cr/s6cr.txt) + +Now you're ready to use it using the `-t/--template` switch. Example: + + $ slideshow build tutorial -t s6cr + +That's it. + + +## PDF generation + + $ wkhtmltopdf --outline --orientation Landscape slide.pdf.html slide.pdf