aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: 36646177adca59273f1953263af13b5804ca9a73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#+TITLE: run64
#+MACRO: ci-badge [[https://ci.systemreboot.net/jobs/$1][https://ci.systemreboot.net/badge/$1.svg]]

{{{ci-badge(run64-website)}}}

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.