Created README with build instructions

This commit is contained in:
Der Teufel 2021-12-30 21:01:43 +01:00
parent ea9fa52a38
commit 782e1a2ca3

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# topiku
topiku is a simple [LISP](https://en.wikipedia.org/wiki/Lisp_(programming_language)) inspired language with [toki pona](https://tokipona.org/) keywords
## Building
To build `topiku` interpreter you need a [Zig](https://ziglang.org/) compiler (works with `master`) and [`editline`](https://github.com/troglobit/editline) installed.
```sh
> git clone https://git.ablecorp.us:443/der-teufel-programming/topiku.git
> cd topiku
> zig build
```
The executable is then found as `zig-out/bin/topiku`
It is also possible to build and run using `zig build run` command.