summary refs log blame commit diff stats
path: root/doc/docs.txt
blob: 8126da86c72101f2b40169509d3ba639105a331c (plain) (tree)
1
2
3
4
5
6
7
8

                                                
                                    

                                                       
                                     
                                                                             
 


                                                                              

                                                      
 
                                         

                                                                        
 


                                                                       



                                                                         



                                                                             



                                                                            
                                           
                                                                              
                                          

                            

                                                    
The documentation consists of several documents:

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

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

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

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

- | `Compiler user guide <nimrodc.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 Nimrod's GC and how to operate it in a
  | realtime setting.

- | `Source code filters <filters.html>`_
  | The Nimrod compiler supports source code filters as a simple yet powerful
    builtin templating system.

- | `Term rewriting macros <trmacros.html>`_
  | Term rewriting macros enhance the compilation process with user defined 
    optimizations.

- | `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**