aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4c08583..e97f229 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,16 @@
# CleanSmurf
Smurf interpreter in Clean
+## Installation
+
+ $ make
+
+## Usage
+
+ $ ./run -i hello.smf
+
+There are more command line flags, see `./run -?`.
+
## Copyright & license
Copyright © 2016 Camil Staps. Licensed under MIT, see LICENSE.