summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMeai1 <Meai1@users.noreply.github.com>2017-03-01 20:08:54 +0100
committerOri Bernstein <ori@eigenstate.org>2017-03-01 11:08:54 -0800
commit62f9c3a555ac291572917775f703460bc8fbc257 (patch)
treed014f2698578ba8b0d85f8b092c2090eea9dd8a4 /README.md
parent5773244f02b16a6be8235b123d518186f44a09d2 (diff)
downloadmc-62f9c3a555ac291572917775f703460bc8fbc257.tar.gz
Update README.md (#135)
So people dont have to read docs just to compile (=primary purpose of this repo, a compiler)
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7368c90..421e556 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,19 @@ and features you may find familiar from languages like like rust and ocaml.
This combination makes Myrddin suitable for anything ranging from desktop
applications, to embedded systems and potentially even kernel development.
+## Build
+
+Compile with ./configure --prefix="/home/wherever/I/want" && make && make install
+The result will be among other things, the binaries 6m and mbld
+
+## Usage
+
+Compile and execute:
+`mbld -R test.myr`
+
+Compile into a binary:
+`mbld -b binary test.myr`
+
## Examples
A classic: