blob: ec33d0827a65a80c21693ce56e4f783caa37d425 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
Nim's Documentation
===================
.. container:: standout
Search Options
--------------
.. container:: internals
`Documentation Index <docs/theindex.html>`_ - The generated
index. **Index + (Ctrl+F) == Joy**
.. 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.
- | `Nim Style Guide <docs/nep1.html>`_
| The stylistic conventions that Nim's official projects adhere to.
- | `Compiler User Guide <docs/nimc.html>`_
| The user guide lists command line arguments, special features of the
compiler, etc.
- | `NimScript <docs/nims.html>`_
| NimScript is the upcoming new way to configure Nim.
- | `Nim Backend Integration <docs/backends.html>`_
| The Backend Integeration guide gives further information of how Nim can
interact with C, C++, Objective C and JavaScript.
.. 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.
|