From a2871d1368652ac4a639af955298a7f285862eba Mon Sep 17 00:00:00 2001 From: Niki Roo Date: Fri, 5 Jul 2024 16:33:38 +0200 Subject: [PATCH] fix Doxyfile, remove docs --- Doxyfile | 8 ++++---- README.md | 45 --------------------------------------------- changelog.md | 9 --------- 3 files changed, 4 insertions(+), 58 deletions(-) delete mode 100644 README.md delete mode 100644 changelog.md diff --git a/Doxyfile b/Doxyfile index f13376ff..560c6232 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1298,15 +1298,15 @@ DOCSET_PUBLISHER_NAME = Publisher # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = YES +# +#GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = +# +#CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, diff --git a/README.md b/README.md deleted file mode 100644 index d29095cf..00000000 --- a/README.md +++ /dev/null @@ -1,45 +0,0 @@ -# Program - -Small description. - -## Synopsis - -- `program --help` - -## Description - -Long description multiple paragraphs are ok. - -## Options - -- **--help** (or **-h**): information about the syntax - -### Supported platforms - -Any platform with at lest Java 1.6 on it should be ok. - -It has been tested on Linux (xxx), and YYY (yyy), but feel free to inform us if you try it on another system. - -If you have any problems to compile it with a supported Java version (1.6+), please contact us. - -## Compilation - -Just run `make`. - -You can also use those make targets: - -- `make jar`: build the jar file -- `make sjar`: build the source jar file -- `make doc`: build the Doxygen documentation (`doxygen` required) -- `make man`: build the man page (`pandoc` required) -- `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built -- `make uninstall PREFIX=/usr/local`: uninstall the program from the given PREFIX -- `make clear`: clear the temporary files -- `make mrpropre`: clear everything, including the main executable and the documentation -- `make test`: build the unit tests (`check` required) -- `make run-test`: start the unit tests - -## Author - -Program was written by Niki Roo - diff --git a/changelog.md b/changelog.md deleted file mode 100644 index ac7d779e..00000000 --- a/changelog.md +++ /dev/null @@ -1,9 +0,0 @@ -# Program - -## Version WIP - -- new: something new -- new: something else new -- changed: something is not the same anymore -- fix: fix/correction of a bug - -- 2.27.0