docs.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. The documentation consists of several documents:
  2. - | `Tutorial (part I) <tut1.html>`_
  3. | The Nim tutorial part one deals with the basics.
  4. - | `Tutorial (part II) <tut2.html>`_
  5. | The Nim tutorial part two deals with the advanced language constructs.
  6. - | `Language Manual <manual.html>`_
  7. | The Nim manual is a draft that will evolve into a proper specification.
  8. - | `Library documentation <lib.html>`_
  9. | This document describes Nim's standard library.
  10. - | `Compiler user guide <nimc.html>`_
  11. | The user guide lists command line arguments, special features of the
  12. compiler, etc.
  13. - | `Tools documentation <tools.html>`_
  14. | Description of some tools that come with the standard distribution.
  15. - | `GC <gc.html>`_
  16. | Additional documentation about Nim's GC and how to operate it in a
  17. | realtime setting.
  18. - | `Source code filters <filters.html>`_
  19. | The Nim compiler supports source code filters as a simple yet powerful
  20. builtin templating system.
  21. - | `Term rewriting macros <trmacros.html>`_
  22. | Term rewriting macros enhance the compilation process with user defined
  23. optimizations.
  24. - | `Internal documentation <intern.html>`_
  25. | The internal documentation describes how the compiler is implemented. Read
  26. this if you want to hack the compiler.
  27. - | `Index <theindex.html>`_
  28. | The generated index. **Index + (Ctrl+F) == Joy**