path: root/doc/docs.txt

  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.

- | `Source code filters <filters.html>`_
  | The Nimrod compiler supports source code filters as a simple yet powerful
    builtin templating system.

- | `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**