diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8fbde9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Verilog to LogicWorld compiler
+
+## Setup
+
+Make sure you clone the repo recursively to include the subassembly library:
+
+```bash
+git clone https://gitea.d4vid.xyz/D4VID/verilog2logicworld.git --recursive
+```
+
+## Run
+
+Run cargo inside the [verilog2logicworld](verilog2logicworld/) directory
+
+```bash
+cargo run
+```