Commit | Line | Data |
---|---|---|
8dd68dca NR |
1 | # Program |
2 | ||
3 | Small description. | |
4 | ||
5 | ## Synopsis | |
6 | ||
7 | - `program --help` | |
8 | ||
9 | ## Description | |
10 | ||
11 | Long description multiple paragraphs are ok. | |
12 | ||
13 | ## Options | |
14 | ||
15 | - **--help** (or **-h**): information about the syntax | |
16 | ||
17 | ## Compilation | |
18 | ||
19 | Just run `make`. | |
20 | ||
21 | You can also use those make targets: | |
22 | ||
23 | - `make doc`: build the Doxygen documentation (`doxygen` required) | |
24 | - `make man`: build the man page (`pandoc` required) | |
25 | - `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built | |
26 | - `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX | |
27 | - `make clear`: clear the temporary files | |
28 | - `make mrpropre`: clear everything, including the main executable and the documentation | |
29 | - `make test`: build the unit tests (`check` required) | |
30 | - `make run-test`: start the unit tests | |
31 | - `make run-test-more`: start the extra unit tests (can be long) | |
32 | ||
33 | ## Author | |
34 | ||
35 | Program was written by Niki Roo <niki@nikiroo.be> | |
36 |