# Nimrod Documentation Overview

Author: | Andreas Rumpf
Version: | 0.9.0

> Incorrect documentation is often worse than no documentation. -- Bertrand Meyer

The documentation consists of several documents:

- Tutorial (part I)
  The Nimrod tutorial part one deals with the basics.

- Tutorial (part II)
  The Nimrod tutorial part two deals with the advanced language constructs.

- Library documentation
  This document describes Nimrod's standard library.

- User guide
  The user guide lists command line arguments, special features of the compiler, etc.

- Tools documentation
  Description of some tools that come with the standard distribution.

- Manual
  The Nimrod manual is a draft that will evolve into a proper specification.

- GC
  Additional documentation about Nimrod's GC and how to operate it in a
  realtime setting.

- Source code filters
  The Nimrod compiler supports source code filters as a simple yet powerful builtin templating system.

- Term rewriting macros
  Term rewriting macros enhance the compilation process with user defined optimizations.

- Internal documentation
  The internal documentation describes how the compiler is implemented. Read this if you want to hack the compiler.

- Index
  The generated index. Index + (Ctrl+F) == Joy

Generated: 2012-09-23 21:47:53 UTC