GitXplorerGitXplorer
g

rdoc-generator-fivefish

public
22 stars
1 forks
0 issues

Commits

List of commits on branch master.
Unverified
bb110408e816fe4d90e99385943080ef7ef0df76

Bump minor version and update history.

gged committed 8 years ago
Unverified
96d13fbd27f17a51dda1e3405733fb22e6fd13da

Bump dependency on RDoc to 5.0.

gged committed 8 years ago
Unverified
b9aad60149d8b547d56c55a8a961250a0c2b4a09

Added tag v0.2.1 for changeset 7c525059a49a

gged committed 8 years ago
Unverified
b8af1015c85c6be2e4822c9e5b5936294d52bed6

Added signature for changeset 41d60500bf23

gged committed 8 years ago
Unverified
b0421a8357c77901ed4677ce010c1e63efda2d17

Fix mistaken dep on RDoc 5.

gged committed 8 years ago
Unverified
4418e30c1835fca1c628a70e3320ac5b856a4e60

Added tag v0.2.0 for changeset 04ce68326c69

gged committed 8 years ago

README

The README file for this repository.

= Fivefish RDoc

== Description

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

It uses {Twitter Bootstrap}[http://twitter.github.com/bootstrap/] for the pretty, 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-fivefish

== Usage

rdoc --format=fivefish

== Contributing

You can check out the current development source {with Mercurial}[http://bitbucket.org/ged/fivefish], or if you prefer Git, via the project's {Github mirror}[https://github.com/ged/Fivefish-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 © 2012, 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.

Fivefish makes extensive use of the Twitter Bootstrap framework, which is used under the following license terms:

Copyright 2012 Twitter, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.