# Sixfish RDoc

* http://deveiate.org/sixfish.html


## Description

A(nother) HTML(5) generator for RDoc.

It uses the {Skeleton Responsive CSS Boilerplate}[http://getskeleton.com/] for
the layout stuff, doesn't take up valuable horizontal real estate space with
indexes and stuff, and has a QuickSilver-like incremental searching.


## Installation

    gem install rdoc-generator-sixfish


## Usage

    rdoc --format=sixfish


## Contributing

You can check out the current development source {with
Mercurial}[http://bitbucket.org/ged/sixfish], or if you prefer Git, via the
project's {Github mirror}[https://github.com/ged/Sixfish-RDoc].

After checking out the source, run:

	$ rake newb

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


## License

Copyright © 2015-2016, Michael Granger
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the author/s, nor the names of the project's
  contributors may be used to endorse or promote products derived from this
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Sixfish uses the Skeleton Responsive CSS Boilerplate, which is used under the
following license terms:

    Skeleton V2.0.4
    Copyright 2014, Dave Gamache
    www.getskeleton.com
    Free to use under the MIT license.
    http://www.opensource.org/licenses/mit-license.php
    12/29/2014