From 1c75b9dca56f4879798d9c9a5b9c48428e117448 Mon Sep 17 00:00:00 2001 From: pacien Date: Sat, 2 Dec 2017 01:06:20 +0100 Subject: Add makefile and its doc Signed-off-by: pacien --- doc/topics/Build.txt | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/topics/Build.txt (limited to 'doc/topics/Build.txt') 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 @@ +Title: Build + +List of the make targets. The global `make all` and `make clean` are also defined. + + +About: Compiling + +> make source + +Compiles all modules. + + +About: Automatic tests + +> make test + +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. -- cgit v1.2.3