commit 4d60f564eef1384831479e5414141c6f638df02b
parent 8711d3d3e85800ef275f73b274cb12a115d30daf
Author: johnsalmon <salmonj@deshawresearch.com>
Date: Thu, 21 Jan 2021 10:25:37 -0500
Don't specify HEADER_HTML in Doxyfile
Also, mention 'make check' in README.md.
Diffstat:
3 files changed, 14 insertions(+), 25 deletions(-)
diff --git 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 <!-- @ref TestsREADME--> `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 <!-- @ref TestsREADME--> "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
@@ -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
@@ -1,11 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>$title</title>
-<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
-$search
-<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css"/>
-</head>
-<body onload='searchBox.OnSelectItem(0);'>
-<div class="tabs"><ul class="tablist"><li style="padding-left: 1.5em; font-weight: bold">$projectname $projectnumber Documentation</li></ul></div>
