diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..62d7058 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +[](https://ci.systemreboot.net/jobs/run64) + +run64 is a [SRFI-64](https://srfi.schemers.org/srfi-64/srfi-64.html) runner. It is a convenience script to run SRFI-64 tests and generate pretty, readable, colorful output. run64 is meant to work with an SRFI-64 implementation, and is not an SRFI-64 implementation in itself. + +# Usage + +To use run64, invoke it on the command-line passing files containing SRFI-64 tests as arguments. For example, + +``` shell +$ run64 test-file1.scm test-file2.scm +``` + +You might want to invoke the *run64* executable specific to your scheme implementation. For example, if you are using GNU Guile, + +``` shell +$ guile-run64 test-file1.scm test-file2.scm +``` + +# Portability + +run64 is written in portable R6RS Scheme. It should work in any R6RS Scheme that supports [SRFI-1](https://srfi.schemers.org/srfi-1/srfi-1.html) and [SRFI-64](https://srfi.schemers.org/srfi-64/srfi-64.html), but has been tested well only with [GNU Guile](https://www.gnu.org/software/guile/). If you use run64 with other Scheme implementations, we would love to hear of your experience. + +# Contributing + +Feedback, suggestions, feature requests, bug reports and pull requests are all welcome. Please write to <arunisaac@systemreboot.net>. + +# License + +run64 is free software released under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html), either version 3 of the License, or (at your option) any later version. |