From aff99a3d80e33f702cf68f58fd8c86a0c36fe90e Mon Sep 17 00:00:00 2001 From: Alex Chaffee Date: Sun, 8 May 2011 10:52:22 -0700 Subject: [PATCH] add Railsbridge Open Workshops to README; ignore generated "doc" dir --- .gitignore | 1 + README.rdoc | 87 +++++++++++++++++++++++++++++++++++++---------------- 2 files changed, 62 insertions(+), 26 deletions(-) diff --git a/.gitignore b/.gitignore index 16ad4b291..c7cb9403c 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ tmtags ## PROJECT::GENERAL coverage rdoc +doc pkg *.gem .bundle diff --git a/README.rdoc b/README.rdoc index 7e34e3003..e11019df2 100644 --- a/README.rdoc +++ b/README.rdoc @@ -7,7 +7,7 @@ hatred in my heart for Keynote and yet it is by far the best in the field. The idea is that you setup your markdown slide files in section subdirectories and then startup the showoff server in that directory. It will read in your -showoff.json file for which sections go in which order and then will give +showoff.json file for which sections go in which order and then will give you a URL to present from. It can: @@ -26,13 +26,14 @@ It might will can: * show a timer - elapsed / remaining * perform simple animations of images moving between keyframes -* show syncronized, hidden notes on another browser (like an iphone) +* show synchronized, hidden notes on another browser (like an iphone) * show audience questions / comments (twitter or direct) * let audience members go back / catch up as you talk * let audience members vote on sections (?) * broadcast itself on Bonjour * let audience members download slides, code samples or other supplementary material * let you write on the slide with your mouse, madden-style via canvas +* automatically resize text to fit screen Some of the nice things are that you can easily version control it, you can easily move sections between presentations, and you can rearrange or @@ -40,7 +41,9 @@ remove sections easily. = Usage -ShowOff is meant to be run in a ShowOff formatted repository - that means that it has a showoff.json file and a number of sections (subdirectories) with markdown files for the slides you're presenting. +ShowOff is meant to be run in a ShowOff formatted repository - that means that +it has a showoff.json file and a number of sections (subdirectories) with +markdown files for the slides you're presenting. $ gem install showoff $ git clone (showoff-repo) @@ -50,11 +53,16 @@ ShowOff is meant to be run in a ShowOff formatted repository - that means that i If you run 'showoff' in the example subdirectory of ShowOff itself, it will show an example presentation, so you can see what it's like. +You can also run 'showoff serve' inside a section subdirectory. If there is no +showoff.json file then it will make its best guess, creating a presentation +from all `.md` files in alphabetical order in the given (or current) +directory. + = Slide Format You can break your slides up into sections of however many subdirectories deep you need. ShowOff will recursively check all the directories mentioned in -your showoff.json file for any markdown files (.md). Each markdown file can +your showoff.json file for any markdown files (.md). Each markdown file can have any number of slides in it, separating each slide with the '!SLIDE' keyword and optional slide styles. @@ -77,7 +85,7 @@ the following contents: That represents two slides, the first contains just a large title, and the second is faded into view showing the title and three bullets that are then incrementally shown. In order for ShowOff to see those slides, your -showoff.json file needs to look something like this: +showoff.json file needs to look something like this: [ {"section":"one"} @@ -147,13 +155,20 @@ The transitions are provided by jQuery Cycle plugin. See http://www.malsup.com/j You can manage the presentation with the following keys: * space, cursor right: next slide -* cursor left: previous slide +* shift-space, cursor left: previous slide * d: debug mode -* c: table of contents (vi) +* c, t: table of contents (vi) * f: toggle footer -* z: toggle help +* z, ?: toggle help * p: toggle preshow += Showing plain old markdown + +If a markdown file has no !SLIDE keywords, then showoff will treat every line +beginning with a single hash -- i.e. every H1 -- as a new slide in "bullets" +style. Remember that you can't specify classes or transitions in this mode, +and as soon as you add one !SLIDE you need them everywhere. + = Preshow If you want to show a slideshow while you wait to speak, you can run a preshow. Add a +_preshow+ directory @@ -166,7 +181,7 @@ audience in the meantime. Press 'p' again to stop, or wait until the timer runs To insert custom JavaScript into your presentation you can either place it into a file (with extension .js) into the root directory of your presentation or you -can embed a