A curses-based ri browser
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib/rdoc
test
.autotest
.gitignore
History.txt
Manifest.txt
README.rdoc
Rakefile

README.rdoc

rdoc-browser

DESCRIPTION:

rdoc-browser is an interactive documentation browser for the terminal.

FEATURES/PROBLEMS:

  • Navigate through all your documentation in a seamless manner

  • Automatic hyperlinking based on your installed gems

  • Navigate forward and backwards through your history

SYNOPSIS:

To start the browser run:

rib

You will be presented with a help screen describing the keys for using the browser. You can return to the help screen at any time by pressing 'H'

REQUIREMENTS:

  • An as-yet unreleased version of ruby with scrollpad support

INSTALL:

  • gem install rdoc-browser

DEVELOPERS:

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the RDoc.

LICENSE:

(The MIT License)

Copyright © 2011 Eric Hodel

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.