aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCamil Staps2018-10-20 20:50:21 +0200
committerCamil Staps2018-10-20 20:54:06 +0200
commit4f0d0ef7636d9868f1d5f31221aef54e81c01646 (patch)
tree9ce9c636819c9596a57dd802e270826cbf20ac06
parentUpdate docker date (diff)
Update readme and Clean version
-rw-r--r--Dockerfile2
-rw-r--r--README.md22
2 files changed, 16 insertions, 8 deletions
diff --git a/Dockerfile b/Dockerfile
index fef93be..116004b 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,6 +1,6 @@
FROM camilstaps/clean:nightly
-RUN install_clean.sh bundle-complete 2018-08-29
+RUN install_clean.sh bundle-complete 2018-10-20
COPY . /usr/src/iclean
WORKDIR /usr/src/iclean
diff --git a/README.md b/README.md
index e8a2833..0c6a86d 100644
--- a/README.md
+++ b/README.md
@@ -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