Software Público Brasileiro

= doc_browser plugin for Rails

Do you also think that's boring to browse your filesystem to reach the
documentation installed on your Rails application? Your probleams are over.

Install doc_browser plugin and browse your documentation from Rails'
development server.

== Usage

Install the plugin:

 ./script/plugin install https://svn.colivre.coop.br/svn/rails/plugins/doc_browser

The plugin installer will create a symbolic link in the public/ directory in
your Rails application, pointing to ../doc (your doc directory at the
application's root). If it doesn't (or if you remove it and decide to add
again), we can do the following:

 cd public; ln -s ../doc

That's it! Now point your browser at http://localhost:3000/doc and see all the
available documentation listed for you.

*Note:* doc_browser plugin is activated only in development mode. (i.e. when
<tt>ENV['RAILS_ENV] == 'development'</tt>)

== Knows limitations

* tested only with WEBrick

== Sending Feedback

Send suggestions, bug reports, patches, pizza and beer to
terceiro@colivre.coop.br

== License

doc_browser - a documentation browser plugin for Rails
Copyright (C) 2007 Colivre <http://www.colivre.coop.br>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Please see the file <tt>LICENSE</tt> (distributed together with the plugin) for
the full terms of distribution.