Merge pull request #333 from jmid/fix-asciidoc

Fix asciidoc in README and add a workflow to check it

Author: jmid

.github/workflows/check-asciidoc.yml

@@ -0,0 +1,17 @@
+name: build
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  run:
+    name: Check asciidoc
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: sudo apt install asciidoc-base
+    - run: asciidoc README.adoc
+

CHANGELOG.md

@@ -6,6 +6,8 @@
 - Adjust `stats` computation of average and standard deviation to
   limit precision loss, print both using scientific notation, and
   workaround MinGW float printing to also pass expect tests
+- Fix dune snippets missing a language specifier in README.adoc
+  causing `asciidoc` to error
 
 ## 0.24
 

README.adoc

@@ -23,8 +23,6 @@ of interest:
 Jan Midtgaard (@jmid) has http://janmidtgaard.dk/quickcheck/index.html[a lecture] about
 property-based testing that relies on QCheck.
 
-toc::[]
-
 == Use
 
 See the documentation. I also wrote
@@ -457,7 +455,7 @@ let _ = QCheck_runner.run_tests_main [test]
 
 with the following `dune` file:
 
-[source]
+[source,lisp]
 ----
 (test
  (name test)
@@ -487,7 +485,7 @@ let _ = QCheck_base_runner.run_tests_main [test]
 and adjust the `dune` file accordingly to use `qcheck-core` and its
 `qcheck-core.runner` sub-package:
 
-[source]
+[source,lisp]
 ----
 (test
  (name test)