blob: 14bdd64b20db7b7f79620b10776f3d67b4327f97 (
plain) (
tree)
|
|
Incorrect documentation is often worse than no documentation.
-- Bertrand Meyer
The documentation consists of several documents:
- | `Tutorial (part I) <tut1.html>`_
| The Nimrod tutorial part one deals with the basics.
- | `Tutorial (part II) <tut2.html>`_
| The Nimrod tutorial part two deals with the advanced language constructs.
- | `Library documentation <lib.html>`_
| This document describes Nimrod's standard library.
- | `User guide <nimrodc.html>`_
| The user guide lists command line arguments, special features of the
compiler, etc.
- | `Tools documentation <tools.html>`_
| Description of some tools that come with the standard distribution.
- | `Manual <manual.html>`_
| The Nimrod manual is a draft that will evolve into a proper specification.
- | `GC <gc.html>`_
| Additional documentation about Nimrod's GC and how to operate it in a
| realtime setting.
- | `Source code filters <filters.html>`_
| The Nimrod compiler supports source code filters as a simple yet powerful
builtin templating system.
- | `Term rewriting macros <trmacros.html>`_
| Term rewriting macros enhance the compilation process with user defined
optimizations.
- | `Internal documentation <intern.html>`_
| The internal documentation describes how the compiler is implemented. Read
this if you want to hack the compiler.
- | `Index <theindex.html>`_
| The generated index. **Index + (Ctrl+F) == Joy**
|