Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

added license and readme

  • Loading branch information...
commit 693f4eea4700d146d567b8ef2fdf43110f5dff07 1 parent dc6610e
Jingwen Owen Ou authored

Showing 2 changed files with 65 additions and 0 deletions. Show diff stats Hide diff stats

  1. +21 0 LICENSE
  2. +44 0 README.markdown
21 LICENSE
... ... @@ -0,0 +1,21 @@
  1 +The MIT License
  2 +
  3 +Copyright (c) 2010 Jingwen Owen Ou
  4 +
  5 +Permission is hereby granted, free of charge, to any person obtaining a copy
  6 +of this software and associated documentation files (the "Software"), to deal
  7 +in the Software without restriction, including without limitation the rights
  8 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9 +copies of the Software, and to permit persons to whom the Software is
  10 +furnished to do so, subject to the following conditions:
  11 +
  12 +The above copyright notice and this permission notice shall be included in
  13 +all copies or substantial portions of the Software.
  14 +
  15 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 +THE SOFTWARE.
44 README.markdown
Source Rendered
... ... @@ -0,0 +1,44 @@
  1 +# JekyllAndHyde
  2 +
  3 +JekyllAndHyde is a HTML presentation generator that generates a basic [Jekyll][1] scaffold with [Slippy][2] hooking up.
  4 +
  5 +# Jekyll
  6 +
  7 +Jekyll is a blog aware static site generator that powers [GitHub Pages][3]. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. GitHub Pages is set up in a way that whenever you push markup files into its Git repository, Jekyll will automatically render them and generate a static website.
  8 +
  9 +# Slippy
  10 +
  11 +Slippy is HTML presentation library written with jQuery that takes a HTML file in and plays the presentation in any browser.
  12 +
  13 +# Why?
  14 +
  15 +Combining Jekyll and Slippy can provide a powerful yet simple solution to create presentations: you use the jekyll_and_hyde gem to generate a Jekyll scaffold with Slippy properly hooking up; you write your slides using Makrdown or Textile; then you publish your slides by pushing it to a Git repository.
  16 +
  17 +# How?
  18 +
  19 +## Installation:
  20 +
  21 + > gem install jekyll
  22 + > gem install jekyll_and_hyde
  23 +
  24 +## Generation:
  25 +
  26 + > jh new my_slides
  27 + > cd my_slides
  28 + > jh generate first-slide
  29 +
  30 + > jh new your_slides --github # set up branching information for GitHub Pages as well
  31 +
  32 +## Other tasks:
  33 +
  34 + > jh list [SEARCH]
  35 + > jh help [TASK]
  36 +
  37 +
  38 +# License
  39 +
  40 +MIT License. Details see LICENSE.
  41 +
  42 +[1]: https://github.com/mojombo/jekyll
  43 +[2]: https://github.com/Seldaek/slippy
  44 +[3]: http://pages.github.com/

0 comments on commit 693f4ee

Please sign in to comment.
Something went wrong with that request. Please try again.