aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac <arunisaac@systemreboot.net>2022-01-23 23:49:50 +0530
committerArun Isaac <arunisaac@systemreboot.net>2022-01-23 23:49:50 +0530
commite8d432ab1a7b22830024bf069618eadc7978f1e5 (patch)
treee56b91aaa65319ef983225d5f11c56109fcdbc85
parentf8ecff20853f2966f7713d11c1f687936dacddc3 (diff)
downloadrun64-e8d432ab1a7b22830024bf069618eadc7978f1e5.tar.gz
run64-e8d432ab1a7b22830024bf069618eadc7978f1e5.tar.lz
run64-e8d432ab1a7b22830024bf069618eadc7978f1e5.zip
README: Add README.
* README.org: New file.
-rw-r--r--README.org37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..0411fd8
--- /dev/null
+++ b/README.org
@@ -0,0 +1,37 @@
+#+TITLE: run64
+
+run64 is a [[https://srfi.schemers.org/srfi-64/srfi-64.html][SRFI-64]] 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,
+#+BEGIN_SRC shell
+ $ run64 test-file1.scm test-file2.scm
+#+END_SRC
+You might want to invoke the /run64/ executable specific to your
+scheme implementation. For example, if you are using GNU Guile,
+#+BEGIN_SRC shell
+ $ guile-run64 test-file1.scm test-file2.scm
+#+END_SRC
+
+* Portability
+
+run64 is written in portable R6RS Scheme. It should work in any R6RS
+Scheme that supports [[https://srfi.schemers.org/srfi-1/srfi-1.html][SRFI-1]] and [[https://srfi.schemers.org/srfi-64/srfi-64.html][SRFI-64]], but has been tested well only
+with [[https://www.gnu.org/software/guile/][GNU 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 [[mailto:arunisaac@systemreboot.net][arunisaac@systemreboot.net]].
+
+* License
+
+run64 is free software released under the terms of the [[https://www.gnu.org/licenses/gpl.html][GNU General
+Public License]], either version 3 of the License, or (at your option)
+any later version.