summary refs log blame commit diff stats
path: root/web/documentation.txt
blob: 67f8b4070bb89cbe5b787c851ae9d41ae4090c88 (plain) (tree)
1
2
3
4
5
6
7
8
9
10







                       

                          
                                           

                                                       
                                             

                                                                               
                                               

                                                                            






                       
                      
 
                                                  


                                                                              
                                                
                                                                           






                       

                          
                                           


                                                                          
                                                    

                                                                             




              
                                                           
                                  
Nim's Documentation
===================

.. container:: standout

  Standards & Guides
  ------------------

  .. container:: libraries

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

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

    - | `Compiler User Guide <docs/nimc.html>`_
      | The user guide lists command line arguments, special features of the
        compiler, etc.


.. container:: standout

  Tools & Features
  ----------------

  .. container:: tools

    - | `Source Code Filters <docs/filters.html>`_
      | The Nim compiler supports source code filters as a simple yet powerful
        builtin templating system.

    - | `Tools Documentation <docs/tools.html>`_
      | Description of some tools that come with the standard distribution.


.. container:: standout

  Internal Details
  ----------------

  .. container:: internals

    - | `Garbage Collector <docs/gc.html>`_
      | Additional documentation about Nim's GC and how to operate it in a
        realtime setting.

    - | `Internal Documentation <docs/intern.html>`_
      | The internal documentation describes how the compiler is implemented.
        Read this if you want to hack the compiler.


Search Options
--------------

`Documentation Index <docs/theindex.html>`_ - The generated
index. **Index + (Ctrl+F) == Joy**