README.md in deckrb-0.2.2 vs README.md in deckrb-0.3.0
- old
+ new
@@ -27,11 +27,11 @@
# Dinner
> "To eat is to live." -Anon.
then run this:
- deck run meals.md
+ deck meals.md
and you'll get a web server running on `http://localhost:4333` serving up a slide presentation with four slides:
* One titled "Breakfast" with three bullet points
* One titled "Lunch" with three H2 headers ("Lunch", "Ham Sandwich", and "Caesar Salad")
@@ -63,35 +63,24 @@
* specify language at the top of the block using either ::: or @@@
* e.g. `@@@ ruby`
## Command-Line API
-`deck run foo.md`
+`deck foo.md`
* start a local Rack server (probably Sinatra) on port 4333
* http://localhost:4333/ serves the presentation built from `foo.md`
* can specify multiple source files in a row
* can also specify a showoff.json file to load multiple markdown files
-`deck build foo.md`
-
- * creates a static page `foo.html` in the current directory
- * unfortunately the `deck.js` source code will not be around so this won't really work yet
-
### Options
-* none yet :-)
+ --port, -p <i>: Specify alternate port (default: 4333)
+ --build, -b: Build an HTML file instead of launching a server (WARNING: not very useful yet)
+ --version, -v: Print version and exit
+ --help, -h: Show this message
-## Command-Line API (proposed)
-
-`deck build foo.md`
-
- * create a static site
- * default output dir = ./public (even if foo.md is elsewhere)
- * copies (or inlines) deck.js source
- * also copies (or inlines) "img" directory if it exists
-
## Credits
* deck.js by Caleb at <http://imakewebthings.com>
* deck.rb by Alex Chaffee <http://alexchaffee.com>, with help from
* Steven! Ragnarök <http://nuclearsandwich.com>
@@ -128,20 +117,22 @@
* command-line tool can take a directory
* first pass: globs all *.md files in it
* command-line options (overriding or complementing config file options)
* --output dir
* --config deck.json
- * --port portnum
* --theme themename
* more slide file types
* Erector - `foo/bar_bar.rb` would expect `class BarBar < Deck::Slide` in there
* html
* slim http://slim-lang.com/index.html
* haml
* tilt
* option to render all JS and CSS inline, for a self-contained HTML doc
- * and maybe images too, base64-encoded
+* `deck --build dir foo.md`
+ * create a self-contained static site inside dir
+ * copies (or inlines) deck.js source, generated html, and axiliary files e.g. images
+ * hell, maybe it should inline everything *including* images (using those base64 urls or whatever) into a single HTML file
* build and push into a gh-pages branch
* build and push into a heroku app
* find any lines that start with a <p>.(something) and turn them into <p class="something">
* see showoff.rb:189
* some way to build/rebuild a project that is deployable to heroku
@@ -154,5 +145,32 @@
* submit theme-picker extension to deck.js
* mix with keydown https://github.com/infews/keydown
* gh-pages documentation site
* integrate with slideshow https://github.com/geraldb/slideshow-deck.js
+
+# License
+
+The MIT License
+
+deck.js Copyright (c) 2011 Caleb Troughton
+
+deck.rb Copyright (c) 2011-12 Alex Chaffee
+
+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.
+