Skip to content

Commit

Permalink
MIT License
Browse files Browse the repository at this point in the history
  • Loading branch information
jdan committed Oct 7, 2012
1 parent 0762729 commit f24fa33
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2012 Jordan Scales

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.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Consider a *very* basic example as shown below:
{
"type": "main",
"title": "Cleaver 101",
"subtitle": "A first look at quick HTML presentations",
"subtitle": "A first look at quick HTML presentations"
},
{
"type": "text",
Expand All @@ -67,7 +67,7 @@ Consider a *very* basic example as shown below:
}
```

### Header Information
## Header Information

**name**: A string representing the name of the document. Currently, cleaver renders to `output.html`,
regardless of a given name.
Expand All @@ -77,7 +77,7 @@ Consider a *very* basic example as shown below:

**description**: An option description of the slideshow.

### Slides
## Slides

**main**: Intro slide containing a `title` and `subtitle`. (`templates/_main.mustache`)

Expand All @@ -88,9 +88,11 @@ Consider a *very* basic example as shown below:

**author**: Automatically-populated, this slide uses information from the `author` hash. (`templates/_author.mustache`)

### Further Information
## Further Information

**Cleaver** produces a *single* document, `output.html` containg CSS and JavaScript (jQuery) code. Everything is
rendered from `templates/layout.mustache`.

To navigate the slideshow: H, J, BACK, DOWN, and Backspace all go back a slide, while everything else goes forward.
To navigate the slideshow: H, J, BACK, DOWN, and Backspace all go back a slide, while everything else goes forward.

[MIT Licensed](https://github.com/prezjordan/cleaver/blob/master/LICENSE)

0 comments on commit f24fa33

Please sign in to comment.