aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2022-09-25 00:04:18 +0200
committerJohannes Stoelp <johannes.stoelp@gmail.com>2022-09-25 00:04:18 +0200
commit7b76c697bd9f733aa242e12a01df4dc3a065a9e0 (patch)
tree3392f82f7a338dd0b8a447428b7a0bb00cee6a75 /README.md
parentda91cbbd5bb8cb925dee4a5c6ab6d66588cb2c8f (diff)
downloadllvm-kaleidoscope-rs-7b76c697bd9f733aa242e12a01df4dc3a065a9e0.tar.gz
llvm-kaleidoscope-rs-7b76c697bd9f733aa242e12a01df4dc3a065a9e0.zip
allow to run program from file, add ch5 example programs
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 95981d5..816e4b9 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,16 @@ going to use the llvm `C` API and build our own safe wrapper specialized for
this tutorial. The wrapper offers a similar interface as the `C++` API and is
implemented in [`src/llvm/`](src/llvm/)
+## Demo
+
+```bash
+# Run kaleidoscope program from file.
+cargo run ks/<file>
+
+# Run REPL loop, parsing from stdin.
+cargo run
+```
+
## Documentation
Rustdoc for this crate is available at