aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2022-07-18 12:28:25 +0100
committerJuan J. Martinez <jjm@usebox.net>2022-07-18 12:28:25 +0100
commitbcec5e47f7e76964c82e59ddba69b5a03be54a60 (patch)
tree02898e584bb9aad7bf6d6d2ee398b545be727c38
parent64a814d49375b8eb63f96a51aa9847b7e56f226f (diff)
downloadmicro-lang-bcec5e47f7e76964c82e59ddba69b5a03be54a60.tar.gz
micro-lang-bcec5e47f7e76964c82e59ddba69b5a03be54a60.zip
Build instructions
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 14b1170..b7bda3f 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,19 @@ A compiler targeting the Z80 CPU was planned, and that is influencing what is av
There's a plugin to provide syntax highlighting in vim. The proposed extension for Micro source code is `.micro` or `.cro`.
+## How to build
+
+Micro requires Go can be built with:
+```
+$ git clone https://git.usebox.net/micro-lang
+$ cd micro-lang
+$ make
+```
+
+`micro` binary should be in `./bin` directory ready to use.
+
+You can also [browse the code via web](https://git.usebox.net/micro-lang.git/about/).
+
### Running the interpreter
Run a script with `micro file.micro`, or start the REPL with `micro`:
@@ -54,5 +67,5 @@ You can also read [the grammar](grammar.md).
## Copying
-This software is distributed under MIT license, unless stated otherwise.
+This software is distributed under MIT license, unless stated otherwise. See [COPYING](COPYING) file for further details.