Skip to content

Commit

Permalink
Don't specify HEADER_HTML in Doxyfile
Browse files Browse the repository at this point in the history
Also, mention 'make check' in README.md.
  • Loading branch information
johnsalmon committed Jan 21, 2021
1 parent 8711d3d commit 4d60f56
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 25 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 0 additions & 11 deletions docs/header.html

This file was deleted.

0 comments on commit 4d60f56

Please sign in to comment.