diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 15 insertions, 7 deletions
@@ -1,9 +1,12 @@ # iClean Interactive Clean -This module allows you to evaluate [Clean][] expressions interactively, similar to GHCi or the Python shell. +This module allows you to evaluate [Clean][] expressions interactively, similar +to GHCi or the Python shell. -Copyright © 2015-2018 Camil Staps. This project is licensed under the MIT license. For more details, see the LICENSE file. +Copyright © 2015–present Camil Staps. +This project is licensed under the MIT license. +For more details, see the [LICENSE](/LICENSE) file. ## Example session @@ -22,13 +25,17 @@ Use `docker pull camilstaps/iclean` to pull the latest iClean version. Run iClean with `docker run --rm -it camilstaps/iclean`. -If you want to import local files as well you can bindmount your local directory by adding `-v "$PWD":/opt/clean/lib/Local`. +If you want to import local files as well you can bindmount your local +directory by adding `-v "$PWD":/opt/clean/lib/Local`. -If you want history, add `-v ~/.iclean_history:/home/.iclean_history` and `touch ~/.iclean_history` on the host. +If you want history, add `-v ~/.iclean_history:/home/.iclean_history` and +`touch ~/.iclean_history` on the host. -You can add imports by creating a template in `~/.iclean_template`, then adding it to the container with `-v ~/.iclean_template:/home/.iclean_template`. +You can add imports by creating a template in `~/.iclean_template`, then adding +it to the container with `-v ~/.iclean_template:/home/.iclean_template`. -If you care about hard disk wear, add `--tmpfs /tmp:exec,size=1024k` to have iClean build on a ramdisk. +If you care about hard disk wear, add `--tmpfs /tmp:exec,size=1024k` to have +iClean build on a ramdisk. Make all this a handy bash function: @@ -41,6 +48,7 @@ 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. +Use either `./iclean` or `make run`. You can of course add the executable +`iclean` to your path. [Clean]:http://clean.cs.ru.nl/Clean |