More cosmetic README.md fixes

Comment out DON'T EDIT THIS FILE Don't put an @anchor in a ##header
DEShawResearch · Feb 21, 2021 · 1f9bd25 · 1f9bd25
1 parent c98cbeb
commit 1f9bd25
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 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>