doc: added README

This commit is contained in:
Yandrik 2021-11-29 23:50:26 +01:00
parent e0e1bc8340
commit 04d0375d2f

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# OverComplicatedCalculator
A parser project for the Compilerbau Vorlesung in WiSe 2021/2022 at Ulm University
## How to build
Install cargo (e.g. from https://rustup.rs). Then open a terminal in the projects root directory, and
run `cargo build` (or `cargo run` to run instantly)
## Grammar
The grammar implemented in this parser is documented [here](./grammar.md).
## Correctness
The implementation is not quite up to spec, as `5/3*2` is interpreted as `5/(3*2)` instead of the desired `(5/3)*2`. I
personally believe that this is not a problem.