1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..340104c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Sample Pants Project
+
+This is just an example of how to use Pants to manage a monorepo. To run from
+scratch you will need to activate a python interpreter `3.6.15` and the
+following command.
+
+```
+./pants run myapp:pex
+```
+
+or to build a pex
+
+```
+./pants package myapp:pex
+./dist/myapp/pex.pex
+```
+
+Things Tested:
+ - How to include a requirements
+ - How to pin a interpreter version (myapp)
+ - How to include an additional local dependancy (mylib)