aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCamil Staps2016-10-18 23:52:49 +0200
committerCamil Staps2016-10-18 23:53:46 +0200
commitca6d92ece51042024ae99e3e52cfb89801db97b0 (patch)
treee20f3ccfebf068e19962122f545169297334d353 /README.md
parentCleanup (diff)
Template file
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index 3654c21..ca99089 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,9 @@ license. For more details, see the LICENSE file.
```
$ ./iclean
λ. [1,2,3,4]
-[1,2,3,4]
+[Int] :: [1,2,3,4]
λ. map toString [1..10]
-["1","2","3","4","5","6","7","8","9","10"]
+[{#Char}] :: ["1","2","3","4","5","6","7","8","9","10"]
λ. [Ctrl-D]
$
```
@@ -23,12 +23,18 @@ $
## Usage
Use `docker pull camilstaps/iclean` to pull the latest iClean version.
-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:
+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.
+
+You can add imports by creating a template in `~/.iclean_template`, then adding
+it to the container with `-v ~/.iclean_template:/home/.iclean_template`.
+
+Make all this an alias:
```
-alias iclean="docker run --rm -it -v ~/.iclean_history:/home/.iclean_history camilstaps/iclean"
+alias iclean="docker run --rm -it -v ~/.iclean_history:/home/.iclean_history -v ~/.iclean_template:/home/.iclean_template camilstaps/iclean"
```
## Without Docker