git://git.nikiroo.be / nikiroo-utils.git / blame
| 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 | ||
| 811796db NR |
17 | ### Supported platforms |
| 18 | ||
| 19 | Any platform with at lest Java 1.6 on it should be ok. | |
| 20 | ||
| 21 | It has been tested on Linux (xxx), and YYY (yyy), but feel free to inform us if you try it on another system. | |
| 22 | ||
| 23 | If you have any problems to compile it with a supported Java version (1.6+), please contact us. | |
| 24 | ||
| 8dd68dca NR |
25 | ## Compilation |
| 26 | ||
| 27 | Just run `make`. | |
| 28 | ||
| 29 | You can also use those make targets: | |
| 30 | ||
| 811796db NR |
31 | - `make jar`: build the jar file |
| 32 | - `make sjar`: build the source jar file | |
| 8dd68dca NR |
33 | - `make doc`: build the Doxygen documentation (`doxygen` required) |
| 34 | - `make man`: build the man page (`pandoc` required) | |
| 35 | - `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built | |
| 36 | - `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX | |
| 37 | - `make clear`: clear the temporary files | |
| 38 | - `make mrpropre`: clear everything, including the main executable and the documentation | |
| 39 | - `make test`: build the unit tests (`check` required) | |
| 40 | - `make run-test`: start the unit tests | |
| 8dd68dca NR |
41 | |
| 42 | ## Author | |
| 43 | ||
| 44 | Program was written by Niki Roo <niki@nikiroo.be> | |
| 45 |