summaryrefslogtreecommitdiff
path: root/doc/topics/build.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/topics/build.txt')
-rw-r--r--doc/topics/build.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/topics/build.txt b/doc/topics/build.txt
new file mode 100644
index 0000000..c461434
--- /dev/null
+++ b/doc/topics/build.txt
@@ -0,0 +1,31 @@
1Title: Build
2
3List of the make targets. The global `make all` and `make clean` are also defined.
4
5
6About: Compiling
7
8> make source
9
10Compiles all modules.
11
12
13About: Automatic tests
14
15> make test
16
17Compiles and runs all unit tests.
18
19
20About: API documentation
21
22> make api-doc
23
24Generates the HTML API documentation with Natural Docs v1.5.
25
26
27About: Project report
28
29> make report
30
31Generates the project report using Pandoc.