Skip to content
Browse files

added license and readme

  • Loading branch information...
1 parent dc6610e commit 693f4eea4700d146d567b8ef2fdf43110f5dff07 @jingweno committed Jan 27, 2011
Showing with 65 additions and 0 deletions.
  1. +21 −0 LICENSE
  2. +44 −0 README.markdown
View
21 LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Jingwen Owen Ou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
44 README.markdown
@@ -0,0 +1,44 @@
+# JekyllAndHyde
+
+JekyllAndHyde is a HTML presentation generator that generates a basic [Jekyll][1] scaffold with [Slippy][2] hooking up.
+
+# Jekyll
+
+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.
+
+# Slippy
+
+Slippy is HTML presentation library written with jQuery that takes a HTML file in and plays the presentation in any browser.
+
+# Why?
+
+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.
+
+# How?
+
+## Installation:
+
+ > gem install jekyll
+ > gem install jekyll_and_hyde
+
+## Generation:
+
+ > jh new my_slides
+ > cd my_slides
+ > jh generate first-slide
+
+ > jh new your_slides --github # set up branching information for GitHub Pages as well
+
+## Other tasks:
+
+ > jh list [SEARCH]
+ > jh help [TASK]
+
+
+# License
+
+MIT License. Details see LICENSE.
+
+[1]: https://github.com/mojombo/jekyll
+[2]: https://github.com/Seldaek/slippy
+[3]: http://pages.github.com/

0 comments on commit 693f4ee

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