summaryrefslogtreecommitdiff
path: root/doc/topics/build.txt
blob: adcd6a875866dcf8783fb898d754decd37804ce9 (plain)
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
Title: Build

List of the make targets. The global `make all` and `make clean` are also defined.


About: Compiling

> make objects

Compiles all modules.

> make build

Compiles the application executable file.


About: Automatic tests

> make check

Compiles and runs all unit tests.


About: API documentation

> make api-doc

Generates the HTML API documentation with Natural Docs v1.5.


About: Project report

> make report

Generates the project report using Pandoc and generate a commit log file.


About: Project archive

> make archive

Generates a compressed tarball containing the project sources and the compiled report as PDF.