Skip to content

mwh/kernan

Repository files navigation

Kernan is an interpreter for the Grace language

Kernan aims to implement the language correctly and without proprietary
extensions. It is written in C# and functions on all platforms, either
natively on Windows or under Mono elsewhere.

Building
========
Windows
-------
This repository can be imported directly into Visual Studio, and builds
and runs directly. `Grace.exe` can be run directly to access the
command-line interface.

Linux and OS X
--------------
Mono is available from <http://www.mono-project.com> and includes both a
runtime and C# compiler. After obtaining and installing Mono, the
repository or an individual subproject can be compiled by running
`xbuild` in its directory. `Grace/grace` is a shell script wrapping the
command-line interface to Kernan.

Usage
=====
To run an individual Grace file, use:
    grace file.grace
with either `Grace.exe` or `Grace/grace` in your path, depending on your
platform.

There is a read-eval-print loop available with the --repl option:
    grace --repl

Source code
===========
The mainline source code of Kernan is available via git from:
    https://mwh.nz/git/kernan

Licence
=======
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version, with the following additional
Section 7c restriction:

    Modified versions of this software must be clearly marked as
    different by not using the name "Kernan".

The text of the GPL is provided in the "GPL3" file in the root of the
repository. This licence applies to all files that do not otherwise
state a different licence in their text.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.