aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCamil Staps2016-01-27 17:38:22 +0100
committerCamil Staps2016-01-27 17:39:14 +0100
commite4cd08a451bccd02838c05226d9f404b13253fca (patch)
tree8b95a9ca7b90d6f379a6cf98e521fbeb7c1582bb /README.md
parentUsing CleanReadLine (diff)
parentUpdate README.md (diff)
Merge branch 'master' of github:camilstaps/iClean
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 10 insertions, 13 deletions
diff --git a/README.md b/README.md
index 3bf9d50..82c68bc 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,32 @@
# iClean
Interactive Clean
-This module allows you to execute 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 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.
Copyright © 2015 Camil Staps. This project is licensed under the MIT license. For more details, see the LICENSE file.
## Example session
$ ./iclean
- > [1,2,3,4]
+ λ. [1,2,3,4]
[1,2,3,4]
- > map toString [1..10]
+ λ. map toString [1..10]
["1","2","3","4","5","6","7","8","9","10"]
- > [Ctrl-D]
+ λ. [Ctrl-D]
$
## Installation
make iclean
-
+
## Running
-Either
-
- ./iclean
+Use either `./iclean` or `make run`. You can of course add the executable `iclean` to your path.
-or
-
- make run
+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.
## Todo
* Implement memory (e.g. to first declare a function / constant and then use it)
- * Commands memory (scroll through previous commands with arrow keys)
- * Imports
+ * Allow extra imports
+
+[clean]:http://clean.cs.ru.nl/Clean