path: root/doc/docs.rst

The documentation consists of several documents:

- | `Tutorial (part I) <tut1.html>`_
  | The Nim tutorial part one deals with the basics.

- | `Tutorial (part II) <tut2.html>`_
  | The Nim tutorial part two deals with the advanced language constructs.

- | `Tutorial (part III) <tut3.html>`_
  | The Nim tutorial part three about Nim's macro system.

- | `Language Manual <manual.html>`_
  | The Nim manual is a draft that will evolve into a proper specification.

- | `Library documentation <lib.html>`_
  | This document describes Nim's standard library.

- | `Compiler user guide <nimc.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.

- | `GC <gc.html>`_
  | Additional documentation about Nim's multi-paradigm memory management strategies
  | and how to operate them in a realtime setting.

- | `Source code filters <filters.html>`_
  | The Nim 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**