Nim Documentation Overview

The documentation consists of several documents:

For developers and contributors

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

• Debugging guide
  Description of the built-in tools for debugging the compiler
  

• Contribution guide
  Contribution guide for |nimskull| projects
  

• Moderation guidelines
  Rules of moderation for |nimskull| projects.
  

• Style guide
  Standard library and compiler style guide
  

• Continuous integration internals
  Describes how CI is implemented and steps for troubleshooting common failures. Required reading for those looking to work on the CI infrastructure.
  

For users

• Language specification
  Description of the language specification purpose and structure.
  

• Tutorial (part I)
  The Nim tutorial part one deals with the basics.
  

• Tutorial (part II)
  The Nim tutorial part two deals with the advanced language constructs.
  

• Tutorial (part III)
  The Nim tutorial part three about Nim's macro system.
  

• Language Manual
  The Nim manual is a draft that will evolve into a proper specification.
  

• Library documentation
  This document describes Nim's standard library.
  

• Compiler 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.
  

• GC
  Additional documentation about Nim's multi-paradigm memory management strategies
  and how to operate them in a realtime setting.
  

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

• Index
  The generated index.