From 321fb5f0f9bcff0288b824520e4a79cc67460027 Mon Sep 17 00:00:00 2001
From: "Rob Moore (MakerX)" <rob.moore@makerx.com.au>
Date: Fri, 8 Dec 2023 18:25:19 +0800
Subject: [PATCH] docs: Adding quick getting started instructions to README.md

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 4288081c98..43ca051ff8 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,17 @@
+# Puya - Algorand TEAL compiler + Python language bindings
+
+```shell
+poetry install
+poetry shell
+python -m src.wyvern
+# OR compile all examples
+python -m scripts.compile_all_examples
+# OR run tests
+pytest
+```
+
+## Existing README stuff - needs clean up
+
 TODO:
 How to handle identity for compound objects i.e. dataclasses so that semantic compatability is retained
     Ideas: