Index and search local rdocs in a browser
Ruby JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
bugs
lib
public
spec
tasks
test
.ditz-config
History.txt
Manifest.txt
README.txt
Rakefile

README.txt

croc
  by Dan Hensgen
  http://www.methodhead.com

== DESCRIPTION:

  Croc indexes your locally installed rdocs and generates an HTML page with a
  quick search box. The search works a bit like gotapi.com.

== FEATURES/PROBLEMS:

* Indexes all locally installed gems
* Installs missing rdocs when possible
* Optionally installs Ruby and Standard Library rdocs
* Untested on everything except Mac

== SYNOPSIS:

  $ croc
  $ open file:///Users/dan/.croc/index.html

== REQUIREMENTS:

  RubyGems 1.2+

== INSTALL:

  $ sudo gem install croc

== LICENSE:

(The MIT License)

Copyright (c) 2008 Dan Hensgen

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.