aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCody <cody@codyq.dev>2023-06-07 03:28:40 -0500
committerCody <cody@codyq.dev>2023-06-07 03:28:40 -0500
commit6f6613419f1511c5637c9f69b3caa5ae838270b9 (patch)
treee203d6cdc0eb2140ae6f0a430e76f2992de66bec /README.md
parent25c5ccb29a6f2387a04bfb5d50874e00084c15d6 (diff)
downloadsloth-6f6613419f1511c5637c9f69b3caa5ae838270b9.tar.gz
Moving over from a VM interpreter to natively compiled w/ LLVM
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index b7793f3..1f154d2 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,9 @@
Sloth is an interpreted high level language written in Rust.
## Build
-To build sloth is easy, just run `cargo build` and you will have your own version of sloth!
+In order to build sloth you will need a valid install of LLVM 15.0.1, you can download LLVM from your package manager or you can download and build LLVM from source from their [downloads page](https://releases.llvm.org/).
+
+After acquiring LLVM just run `cargo build` and you will have your own version of the sloth compiler!
## Disclaimer
Sloth is in very early development is NOT meant to be used for actual projects yet. Feel free to contribute to the project via Pull Request and open issues if you can. Thank you for using sloth!