aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2023-01-05 21:23:50 +0100
committerJohannes Stoelp <johannes.stoelp@gmail.com>2023-01-05 21:23:50 +0100
commit802cca1963bc27f8ea4e4923029909e45464d3df (patch)
treea473a1e1a03e5907fcf82e24f260b0b7d8ec7d8a /README.md
parent295081130ca1eed6e67dfc035e2df2c9ed49b174 (diff)
downloadllvm-kaleidoscope-rs-802cca1963bc27f8ea4e4923029909e45464d3df.tar.gz
llvm-kaleidoscope-rs-802cca1963bc27f8ea4e4923029909e45464d3df.zip
bump to llvm14 and add docker file
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 816e4b9..b68e9a7 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@ Implementing a Language with LLVM`][llvm-tutorial]. This tutorial is written in
implement every chapter in rust.
The topics of the chapters are as follows:
+
- Chapter 1: [Kaleidoscope Introduction and the Lexer][llvm-ch1]
- Chapter 2: [Implementing a Parser and AST][llvm-ch2]
- Chapter 3: [Code generation to LLVM IR][llvm-ch3]
@@ -51,6 +52,20 @@ cargo run
Rustdoc for this crate is available at
[johannst.github.io/llvm-kaleidoscope-rs][gh-pages].
+## Build with provided container file
+
+The provided [Dockerfile](docker/Dockerfile) documents the required
+dependencies for an ubuntu based system and serves as a build environment with
+the correct llvm version as specified in the [Cargo.toml](Cargo.toml) file.
+
+```bash
+# Build the image *ks-rs*. Depending on the downlink this may take some minutes.
+make -C docker
+
+podman run --rm -it -v $PWD:/work -w /work ks-rs
+# Drops into a shell in the container, just use cargo build / run ...
+```
+
## License
This project is licensed under the [MIT](LICENSE) license.