aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md29
1 files changed, 28 insertions, 1 deletions
diff --git a/README.md b/README.md
index 526ac35..6393650 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
-# cie-pseudocode-compiler \ No newline at end of file
+# cie-pseudocode-compiler
+
+A compiler for CIE Pseudocode (A Level 9618 Computer Science)
+
+Details can be found here: [Pseudocode Guide for Teachers](https://www.cambridgeinternational.org/Images/697401-2026-pseudocode-guide-for-teachers.pdf)
+
+
+## Dependencies
+
+```bash
+sudo apt-get update
+sudo apt-get install -y \
+ build-essential \
+ cmake \
+ llvm-18-dev \
+ llvm \
+ clang \
+ lld
+```
+
+
+## Build
+
+```bash
+mkdir build && cd build/
+cmake ..
+make
+```