diff options
author | pacien | 2017-12-02 01:06:20 +0100 |
---|---|---|
committer | pacien | 2017-12-02 01:06:20 +0100 |
commit | 1c75b9dca56f4879798d9c9a5b9c48428e117448 (patch) | |
tree | 19f07dce18795b466a83cef4e0bf355aaf6cf600 /doc/topics/Build.txt | |
parent | 144b1236f43ccb126415a1a2d518675c00f9f778 (diff) | |
download | morpher-1c75b9dca56f4879798d9c9a5b9c48428e117448.tar.gz |
Add makefile and its doc
Signed-off-by: pacien <pacien.trangirard@pacien.net>
Diffstat (limited to 'doc/topics/Build.txt')
-rw-r--r-- | doc/topics/Build.txt | 31 |
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 @@ | |||
1 | Title: Build | ||
2 | |||
3 | List of the make targets. The global `make all` and `make clean` are also defined. | ||
4 | |||
5 | |||
6 | About: Compiling | ||
7 | |||
8 | > make source | ||
9 | |||
10 | Compiles all modules. | ||
11 | |||
12 | |||
13 | About: Automatic tests | ||
14 | |||
15 | > make test | ||
16 | |||
17 | Compiles and runs all unit tests. | ||
18 | |||
19 | |||
20 | About: API documentation | ||
21 | |||
22 | > make api-doc | ||
23 | |||
24 | Generates the HTML API documentation with Natural Docs v1.5. | ||
25 | |||
26 | |||
27 | About: Project report | ||
28 | |||
29 | > make report | ||
30 | |||
31 | Generates the project report using Pandoc. | ||