sowl / mint Goto Github PK

* Mint *

Mint is a small, fast documentation generator for literate-style programming
that produces HTML files from your source code. In literate programming, the
emphasis is placed on writing clear documentation in ordinary human language
instead of writing terse half-sentences. The code is considered merely an
artifact of the documentation. Thus, in Mint the documentation is displayed
most prominently, right alongside the fragments of code to which each section
pertains.

Mint was inspired by (and borrows heavily from) Docco, the original quick-n-dirty
literate documentation generator by Jeremy Ashkenas. However, Mint is written
in JavaScript instead of CoffeeScript. Code comments are written in Markdown
and templates use Mustache.

### Installation

Mint has several dependencies, including Node.js and Pygments. Please consult
the websites of these projects for instructions on how to install them.

Once you have Node and Pygments installed, simply clone the repository and run
a `make && make install` from the project root.

    $ git clone git://github.com/mjijackson/mint.git
    $ cd mint
    $ make && make install

By default the Mint installer uses the `/usr/local` prefix. You can however
change this prefix to point to a different place on your system.

    $ sudo make install prefix=/usr

Uninstalling Mint is just as easy.

    $ make uninstall

### Usage

Invoke the `mint` program from the command line with a list of files you would
like to generate documentation for. To specify the location for the output,
use the `-o` flag. For example, to generate documentation for all JavaScript
files in the `lib` directory and put the output in the `doc` directory, you
would do the following:

    $ mint -o doc lib/*.js

For more information, try `--help`.

    $ mint --help

Use the `node` program to run the Mint test suite.

    $ node test/mint.js

### Credits

Mint uses the following libraries to get the job done:

  - Node.js (http://nodejs.org/)
  - Pygments (http://pygments.org/)
  - markdown-js (http://github.com/evilstreak/markdown-js)
  - Mu (http://github.com/raycmorgan/Mu)
  - optparse-js (http://github.com/jfd/optparse-js)

### License

MIT License

Copyright 2010 Michael Jackson

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.