diff options
Diffstat (limited to 'doc/docs.md')
| -rw-r--r-- | doc/docs.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/docs.md b/doc/docs.md new file mode 100644 index 000000000..b6ff6d2c7 --- /dev/null +++ b/doc/docs.md @@ -0,0 +1,38 @@ +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. + +- | [Memory management](mm.html) + | Additional documentation about Nim's 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** |