azkaban-aplcache
Changes
tools/README.md 11(+11 -0)
Details
tools/README.md 11(+11 -0)
diff --git a/tools/README.md b/tools/README.md
index fae4683..5f27481 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -1,2 +1,13 @@
The python scripts in this directory require python3.
A python virtual environment is recommended to run these scripts.
+
+The tool assumes that the upstream remote points to the main repo.
+
+e.g.
+
+ (python-3.7.0)[~/oss/azkaban (master)]$ git remote -v
+ origin git@github.com:HappyRay/azkaban.git (fetch)
+ origin git@github.com:HappyRay/azkaban.git (push)
+ upstream git@github.com:azkaban/azkaban.git (fetch)
+ upstream git@github.com:azkaban/azkaban.git (push)
+