summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOri Bernstein <ori@eigenstate.org>2017-03-05 13:52:17 -0800
committerOri Bernstein <ori@eigenstate.org>2017-03-05 13:54:27 -0800
commitb3d835e235336f8c0e1979fe009eefb24117a169 (patch)
tree67bcc668d9e2b2c521e2872908d529ce60c2b2d4 /README.md
parentb623656b7898648e82dcc0adc5c4d03a5ba9b5da (diff)
parent2bb663c4e88ad3602a2402a039b18a30d7acf556 (diff)
downloadmc-b3d835e235336f8c0e1979fe009eefb24117a169.tar.gz
Merge branch 'master' of git+ssh://git.eigenstate.org/git/ori/mc
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3c6d3a7..578f96f 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:
@@ -77,8 +90,9 @@ Annoucements of major changes, questions, complaints. We also give relationship
## Supported Platforms
Myrddin currently runs on a number of platforms
-- Linux
-- OSX
- FreeBSD
+- Linux
- NetBSD
-- 9front
+- OSX
+- OpenBSD
+- Plan9front