Contents

= wrongdoc - RDoc done right (IMNSHO)

wrongdoc mangles an existing RDoc directory and makes any changes we
feel like.  It mainly removes JavaScript from Darkfish and adds links to
a {cgit}[http://hjemli.net/git/cgit/] instance.  It is a bikeshed
project and *entirely* subject to the whims of its creator, so it is
likely the wrong solution for anybody else.

wrongdoc is tightly integrated with git and cgit, and capable of of
automatically generating NEWS and ChangeLog files in RDoc format based
on git history and tags.

== Usage

First, prepare a .wrongdoc.yml in the top-level directory of your project,
then run the following command to generate your RDoc:

    $ wrongdoc

== Future Plans

* Remove images/icons from Darkfish without breaking text alignment.

* Optimize for small screens at the expense of large ones.

* gitweb support (preserving cgit support)

* ASCII-art unicorns and rainbows! (maybe)

== Feedback

It's Free Software, fork it and hack it to your heart's content, just
do not expect the original author(s) to support anything they disagree
with.  Remember, this is a bikeshed project!

Help with CSS for removing image/icon cruft and making better use of
small screen real-estate would be greatly appreciated.

The original authors may be contacted through the mailing list:
{[e-mail]}[mailto:[e-mail]].

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
wrongdoc-1.4.0	README
wrongdoc-1.3.0	README
wrongdoc-1.1.1	README
wrongdoc-1.1.0	README
wrongdoc-1.0.1	README
wrongdoc-1.0.0	README