From c4792f9881e9f9fb35aa7a2c966031216ed74597 Mon Sep 17 00:00:00 2001 From: Melody Horn Date: Sun, 25 Oct 2020 03:07:13 -0600 Subject: write a real README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index e69de29..f0e69a2 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,26 @@ +the reference compiler for the [Crowbar](https://sr.ht/~boringcactus/crowbar-lang/) language. + +requirements: +* [QBE](https://c9x.me/compile/) installed somewhere on your PATH +* gcc + +usage (i probably will forget to update this so [check directly](https://git.sr.ht/~boringcactus/crowbar-reference-compiler/tree/main/crowbar_reference_compiler/__init__.py)): +``` +usage: crowbarc-reference [-h] [-V] [-g] [--stop-at-parse-tree] + [--stop-at-qbe-ssa] [-S] [-o OUT] + input + +The reference compiler for the Crowbar programming language + +positional arguments: + input input file + +optional arguments: + -h, --help show this help message and exit + -V, --version show program's version number and exit + -g, --include-debug-info + --stop-at-parse-tree + --stop-at-qbe-ssa + -S, --stop-at-assembly + -o OUT, --out OUT output file +``` -- cgit v1.2.3