From 4d60f564eef1384831479e5414141c6f638df02b Mon Sep 17 00:00:00 2001 From: johnsalmon Date: Thu, 21 Jan 2021 10:25:37 -0500 Subject: [PATCH] Don't specify HEADER_HTML in Doxyfile Also, mention 'make check' in README.md. --- README.md | 26 +++++++++++++------------- docs/Doxyfile | 2 +- docs/header.html | 11 ----------- 3 files changed, 14 insertions(+), 25 deletions(-) delete mode 100644 docs/header.html diff --git a/README.md b/README.md index c0e72d9..35d9e8e 100644 --- a/README.md +++ b/README.md @@ -108,19 +108,19 @@ C++ compiler to find the header files in the `include/` directory of the cloned repo and use the Random123 header files, types, and functions in your application. -There is a top-level GNUmakefile with "install" and "install-html" -targets. The former will copy header files to $(DESTDIR)$(includedir) -(default: /usr/local/include). The latter will run doxygen, with -OUTPUT_DIRECTORY=$(DESTDIR)$(docdir)/html (default: /usr/local/doc/Random123/html). - -In addition to the `include/` files which implement the library, the -distribution also contains an `examples/` and a `tests/` directory. Users are -**STRONGLY ADVISED** to compile and run the tests in `tests/` before using -Random123 in an application (see `tests/README`). -Do not use the library if any tests fail. (It is not a failure for -a test to report that it cannot run because of missing -hardware capabilities like 64bit multiply, -SSE, AES-NI or compiler capabilities) +Users and packagers are **STRONGLY ADVISED** run `make check` to +compile and run the tests in `tests/` before using Random123 in an +application (see "tests/README"). Do not use +the library if any tests fail. (It is not a failure for a test to +report that it cannot run because of missing hardware capabilities +like 64bit multiply, SSE, AES-NI or compiler capabilities) + +The top-level GNUmakefile also has "install", "html", and +"install-html" targets. The former will copy header files to +\$(DESTDIR)\$(includedir) (default: /usr/local/include). The second +will run doxygen, replacing anything in docs/html. The last will +install the documentation in \$(DESTDIR)\$(docdir)/html (default: +/usr/local/doc/Random123/html). ## Usage diff --git a/docs/Doxyfile b/docs/Doxyfile index 6aeb080..27f9820 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -21,7 +21,7 @@ INPUT = main.md cbrng.dox releasenotes.dox \ #USE_MDFILE_AS_MAINPAGE = -HTML_HEADER = header.html +#HTML_HEADER = header.html HTML_TIMESTAMP = YES GENERATE_LATEX = NO MACRO_EXPANSION = YES diff --git a/docs/header.html b/docs/header.html deleted file mode 100644 index fa4eaf2..0000000 --- a/docs/header.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - -$title - -$search - - - -