(Arne Babenhauserheide)
2017-08-20: README: note the releases and split usage into setup+usage README: note the releases and split usage into setup+usage
diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -34,18 +34,30 @@ Requirements [GNU Guile 2.x]: http://gnu.org/s/guile "GNU Guile: The official extension language for the GNU operating system." [Python 3.x]: http://python.org "Python Programming Language" -Usage +Setup ----- +From the repository: + * Get wisp: `hg clone http://draketo.de/proj/wisp` (needs [Mercurial](http://mercurial-scm.org)) * Bootstrap: `cd wisp && autoreconf -i && ./configure && make` -* Preprocess files: `guile ./wisp.scm infile.wisp > outfile.scm` -* Wisp at the REPL: `guile -L . --language=wisp # in the wisp-folder` + +From a release: + +* Get a release from [bitbucket.org/ArneBab/wisp/downloads/](https://bitbucket.org/ArneBab/wisp/downloads/) +* Unpack and build: `tar xf [release].tar.gz; cd [release]; ./configure; make` Install systemwide with `./configure --datarootdir=/usr/share && sudo make install`, then you can run `guile --language=wisp` anywhere. Install in your home folder with `./configure --prefix=$HOME/.local; make install`. Use `guile -c '(import (language wisp spec))'` to get rid of auto-compile errors. Run tests with `make check`. Distribute your own version with `make distcheck`. +Usage +----- + +* Preprocess files: `guile ./wisp.scm infile.wisp > outfile.scm` +* Wisp at the REPL: `guile -L . --language=wisp # in the wisp-folder` +* The files in examples/ show how to make executable wisp programs. + Wisp and curly infix (SRFI-105) -------------------------------