docs: Adding quick getting started instructions to README.md

algorandfoundation · Dec 8, 2023 · 321fb5f · 321fb5f
1 parent b382d5a
commit 321fb5f
Showing 1 changed file with 14 additions and 0 deletions.
diff --git 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: