Document usage.

codecop · Apr 18, 2021 · 90269cc · 90269cc
1 parent a216acb
commit 90269cc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,12 @@
-# assert-scm #
+# assert-scm
 
 Minimalist xUnit test framework for Scheme R5RS.
+
+## Usage
+
+`assert.scm` is a minimalist (Gambit) R5RS implementation of xUnit in Scheme style.
+There are several assertions available, e.g. `(assert=)` for numbers, `(assert-string=)` and `(assert-raise)`.
+
+To run the self-test:
+
+    gsi assert-test.scm
diff --git a/test_with_chicken.bat b/test_with_chicken.bat
@@ -1 +1,2 @@
+@rem run self test with Chicken Scheme interpreter
 "C:\Program Files (x86)\ChickenScheme\bin\csi.exe" -r5rs-syntax -q -b assert-chicken-test.scm
diff --git a/test_with_gambit.bat b/test_with_gambit.bat
@@ -1 +1,2 @@
+@rem run self test with Gambit Scheme interpreter
 "C:\Program Files\Gambit\v4.8.1\bin\gsi.exe" -:s assert-test.scm