readme: add small explanations

This commit is contained in:
Bruno BELANYI 2020-09-29 18:26:29 +02:00
parent 1a1148b2b2
commit 1261aa9f66

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Jitters
This is a small experiment in writing a JIT-compiled calculator. It can
pretty-print, evaluate the AST, compile to assembly, or JIT compile and
interpret the input expression.
## Building
```sh
./bootstrap # Also launches configure
make
```
## How to use
To show the different options, use:
```sh
./jitters --help
```
Once launched, you can write your expression in it's standard input.