aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2021-09-03 00:13:32 +0200
committerJohannes Stoelp <johannes.stoelp@gmail.com>2021-09-03 00:13:32 +0200
commit31d81a3931216d60a2e23426287f32f481104b71 (patch)
tree98528659b1fcfabb0dfc4a9135aa463b19fb676c /README.md
parent057f7edc9d6249f62917d93c01fccb60a84f9763 (diff)
downloadllvm-kaleidoscope-rs-31d81a3931216d60a2e23426287f32f481104b71.tar.gz
llvm-kaleidoscope-rs-31d81a3931216d60a2e23426287f32f481104b71.zip
readme: update not on structure
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8d1b4e6..8e4fdd8 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,10 @@
Follow the official llvm tutorial [`Kaleidoscope: Implementing a Language with
LLVM`][llvm-tutorial] to learn about `llvm` and practice some `rust`.
+Names of variables and functions as well as file structure are mainly kept as
+in the tutorial. This makes it easy to map the `rust` implementation onto the
+`C++` implementation when following the tutorial.
+
## License
This project is licensed under the [MIT](LICENSE) license.