From: Georg Sauthoff Date: Mon, 10 Mar 2014 12:54:43 +0000 (+0100) Subject: update build instructions, tested platforms in README X-Git-Url: https://git.kevux.org/?a=commitdiff_plain;h=8332014a20a76859f2ca13ff98133a6d75d70f3d;p=doxy2man update build instructions, tested platforms in README --- diff --git a/README.md b/README.md index 0fd41ef..14291f7 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,16 @@ information, brief and detailed descriptions, etc. ## Compile -Doxy2man is written in C++ and uses the [Qt][2] library (I tested it with version 4.8). You can build it like this: +Doxy2man is written in C++ and uses the [Qt][2] library (I tested it with version 4.8 and 5.2). You can build it like this: $ qmake-qt4 $ make +Or: + + $ qmake-qt5 + $ make + ## Usage Create a small Doxygen configuration file. To enable XML output use something like this: @@ -79,13 +84,25 @@ Doxy2man implements several useful defaults but is also customizable: --pkg STR man page header/footer string, e.g. 'Linux Programmer's Manual' -i STR, --include STR include path prefix -## Contact ## +## Contact Georg Sauthoff Don't hesitate to mail questions, comments or other feedback. -## License ## +## Tested platforms + +Qt libraries: + +- Qt 4.8 +- Qt 5.2 + +Operating systems: + +- Fedora Linux 17, 19 (x86/64) +- Solaris 10/SPARC + +## License GPLv3+