Merge pull request #1 from algorandfoundation/small-tweaks

Small tweaks
algorandfoundation · Dec 8, 2023 · 947bc86 · 947bc86
2 parents cfc68c7 + 34bfd04
commit 947bc86
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,4 @@
+* text=auto eol=lf
 examples/**/*.ir linguist-generated=true
 examples/**/*.debug.teal linguist-generated=true
 examples/**/*.log linguist-generated=true

diff --git a/README.md b/README.md
@@ -1,3 +1,18 @@
+# Puya - Algorand TEAL compiler + Python language bindings
+
+```shell
+poetry install
+poetry shell
+# Run the compiler
+algopy
+# 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: