commit 1f9bd25da941c3e8b86aff134c5c70d85682c01d
parent c98cbeb70590dd53896950c67520b152ae01345c
Author: John Salmon <john@thesalmons.org>
Date: Sun, 21 Feb 2021 16:23:30 -0500
More cosmetic README.md fixes
Comment out DON'T EDIT THIS FILE
Don't put an @anchor in a ##header
Diffstat:
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/GNUmakefile b/GNUmakefile
@@ -31,7 +31,7 @@ install-include:
# directive, and the @ref directives are *not* commented out.
docs/main.md : README.md
echo @mainpage Random123: a Library of Counter-Based Random Number Generators > docs/main.md
- echo DO NOT EDIT THIS FILE. IT IS GENERATED by ../GNUmakefile >> docs/main.md
+ echo '<!--- DO NOT EDIT THIS FILE. IT IS GENERATED by ../GNUmakefile -->' >> docs/main.md
sed -e 's/<!-- \([^-]*\)-->/\1/g' README.md >> docs/main.md
# the html target removes and then recreates docs/html.
diff --git a/README.md b/README.md
@@ -80,7 +80,8 @@ typedefs) begin either with `r123` or with one of the RNG family names, e.g.,
`threefry`, `philox`, `ars`, `aesni`. The RNG functions themselves have names like
`philox4x32`. C++ class names are capitalized, e.g., `Threefry4x32`.
-## <!-- @anchor families--> The different families of Random123 generators
+<!-- @anchor families-->
+## The different families of Random123 generators
Several families of CBRNGs are available in this version of the library:
<ul>
