From: Niki Roo Date: Fri, 5 Jul 2024 14:33:00 +0000 (+0200) Subject: fix Doxyfile, remove docs X-Git-Url: https://git.nikiroo.be/?a=commitdiff_plain;h=refs%2Fheads%2Fc-master;p=template.git fix Doxyfile, remove docs --- diff --git a/Doxyfile b/Doxyfile index cd944e0..979603a 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 2e797e4..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Program - -Small description. - -## Synopsis - -- `program --help` - -## Description - -Long description multiple paragraphs are ok. - -## Options - -- **--help** (or **-h**): information about the syntax - -## Compilation - -Just run `make`. - -You can also use those make targets: - -- `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 -- `make run-test-more`: start the extra unit tests (can be long) - -## Author - -Program was written by Niki Roo - diff --git a/changelog.md b/changelog.md deleted file mode 100644 index ac7d779..0000000 --- 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 -