= rdoc_osx_dictionary

home :: https://github.com/seattlerb/rdoc_osx_dictionary
rdoc :: http://docs.seattlerb.org/rdoc_osx_dictionary

== DESCRIPTION:

rdoc via Apple's Dictionary.app. Automatically builds and installs an
Apple Dictionary with all rdoc nicely formatted.

Inspired by: http://priithaamer.com/blog/ruby-on-rails-dictionary-for-macosx

== FEATURES/PROBLEMS:

* Automatically builds and installs an Apple Dictionary with all rdoc
  nicely formatted.

== REQUIREMENTS:

* rdoc gem
* rubygems
* Mac OS X w/ Developer Tools

== INSTALL:

* sudo gem install rdoc_osx_dictionary

== USAGE:

1. Download Auxiliary Tools for Xcode from {Apple Developer}[http://developer.apple.com].
2. Mount the dmg by click.
3. Execute rdoc_osx_dictionary in terminal.

== LICENSE:

(The MIT License)

Copyright (c) Ryan Davis, seattle.rb

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.