aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index af4d8b6..95981d5 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,13 @@ Implementing a Language with LLVM`][llvm-tutorial]. This tutorial is written in
`C++` and structured in multiple chapters, we will try to follow along and
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]
+- Chapter 4: [Adding JIT and Optimizer Support][llvm-ch4]
+- Chapter 5: [Extending the Language: Control Flow][llvm-ch5]
+
The implementation after each chapter can be compiled and executed by checking
out the corresponding tag for the chapter.
```bash
@@ -16,6 +23,7 @@ chapter1
chapter2
chapter3
chapter4
+chapter5
```
Names of variables and functions as well as the structure of the functions are
@@ -39,5 +47,10 @@ This project is licensed under the [MIT](LICENSE) license.
[llvm]: https://llvm.org
[llvm-tutorial]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/index.html
+[llvm-ch1]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl01.html
+[llvm-ch2]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl02.html
+[llvm-ch3]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl03.html
+[llvm-ch4]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl04.html
+[llvm-ch5]: https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl05.html
[rust]: https://www.rust-lang.org
[gh-pages]: https://johannst.github.io/llvm-kaleidoscope-rs/llvm_kaleidoscope_rs/index.html