Merge pull request #3 from jgclark/patch-1

Adding some installation and usage help.

1 files changed, 14 insertions, 2 deletions

diff --git a/document_keybindings.rb b/document_keybindings.rb
index a4edd41..13dbe2d 100755
--- a/document_keybindings.rb
+++ b/document_keybindings.rb
@@ -25,19 +25,30 @@ td:last-child { font-weight:normal;width:auto }
 STYLE
 
 intro =<<INTRO
-DefaultKeyBindings.dict file (`~/Library/KeyBindings/DefaultKeyBindings.dict`) for Mac OS X, created by [Brett Terpstra][] and based heavily on work done by [Lri][lrikeys]. See Lri's [gists][lrigists] and [website][lriweb] for more coding madness. Documentation last updated #{date}.
+DefaultKeyBindings.dict file (`~/Library/KeyBindings/DefaultKeyBindings.dict`) for Mac OS X, created by [Brett Terpstra][] and based heavily on work done by [Lri][lrikeys].
+Please note that these bindings won't work in all applications: TextWrangler and TextMate, for example, override these with their own settings.
+See Lri's [gists][lrigists] and [website][lriweb] for more coding madness.
 
 [lrikeys]: http://www.cs.helsinki.fi/u/lranta/keybindings/
 [lriweb]: http://www.cs.helsinki.fi/u/lranta/
 [lrigists]: https://gist.github.com/Lri
 [brett terpstra]: http://brettterpstra.com
 
-This documentation is generated automatically from the comments and commands in the DefaultKeyBinding.dict file. The script `document_keybindings.rb` is free for use, but it's specifically designed for use with my formatting in the bindings plist (i.e. it's a little finicky).
+<b>Installation</b>: Copy the DefaultKeyBindings.dict file to the `~/Library/KeyBindings/` directory (create `KeyBindings` if it doesn't already exist). 
+Any open applications will need to be re-started before the key bindings will take effect -- or log out and log back in.
+
+<b>Documentation</b> <i>(last updated #{date}.)</i>
 
 *Grouped items begin with the groups shortcut (if exists), followed by a subgroup (if exists) followed by the keys specified.*
 
 INTRO
 
+outro =<<OUTRO
+
+This documentation is generated automatically from the comments and commands in the DefaultKeyBinding.dict file. The script `document_keybindings.rb` is free for use, but it's specifically designed for use with my formatting in the bindings plist (i.e. it's a little finicky).
+
+OUTRO
+
 toplevel = []
 
 level = 0
@@ -126,4 +137,5 @@ htmlout = %x{echo #{e_sh output}|/usr/local/bin/multimarkdown}
 outfile = File.new('readme.md','w')
 outfile.puts intro
 outfile.puts htmlout
+outfile.puts outro
 outfile.close
\ No newline at end of file