diff options
| author | Camil Staps | 2016-10-16 20:34:32 +0200 |
|---|---|---|
| committer | Camil Staps | 2016-10-16 20:34:32 +0200 |
| commit | 2c2a20f522d558445400853c44a348611fd12f71 (patch) | |
| tree | 55b644ac271fce574b7f76eb832afcb41753eb7b /README.md | |
| parent | Use genShow from genLibTest instead of gPrint (can show -> type) (diff) | |
Docker
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 20 insertions, 9 deletions
@@ -1,9 +1,12 @@ # iClean Interactive Clean -This module allows you to execute [Clean][clean] commands interactively, similar to GHCi or the Python shell. Functionality is very limited. In particular there is **no memory**, so you're restricted to one-liners. +This module allows you to evaluate [Clean][] expressions interactively, similar +to GHCi or the Python shell. Functionality is very limited. In particular there +is **no memory**, so you're restricted to one-liners. -Copyright © 2015 Camil Staps. This project is licensed under the MIT license. For more details, see the LICENSE file. +Copyright © 2016 Camil Staps. This project is licensed under the MIT +license. For more details, see the LICENSE file. ## Example session @@ -15,18 +18,26 @@ Copyright © 2015 Camil Staps. This project is licensed under the MIT licens λ. [Ctrl-D] $ -## Installation +## Usage +Use `docker pull camilstaps/iclean` to pull the latest iClean version. - make iclean - -## Running -Use either `./iclean` or `make run`. You can of course add the executable `iclean` to your path. +Run iClean with `docker run --rm -it camilstaps/iclean`. If you want history, +add `-v ~/.iclean_history:/home/.iclean_history` and `touch ~/.iclean_history` +on the host. Make it an alias: -Disabling displaying `65536` and the execution times after a session (which is a Clean default) can be done by adding `-nr` and `-nt` to the command line arguments, respectively. You may want to make this an alias. +``` +alias iclean="docker run --rm -it -v ~/.iclean_history:/home/.iclean_history camilstaps/iclean" +``` + +## Without Docker +Use `make iclean` to build. + +Use either `./iclean` or `make run`. You can of course add the executable +`iclean` to your path. ## Todo * Implement memory (e.g. to first declare a function / constant and then use it) * Allow extra imports -[clean]:http://clean.cs.ru.nl/Clean +[Clean]:http://clean.cs.ru.nl/Clean |