Add pydoc documentation to the source, and a __main__ section to make…

… it work. Also add '##' so that one can grep/awk for the sequence of actions taken. Add a note accordingly into README.md.
Katello · Nov 2, 2016 · 15c6d15 · 15c6d15
1 parent d9e3fae
commit 15c6d15
Show file tree

Hide file tree

Showing 2 changed files with 305 additions and 180 deletions.
diff --git a/README.md b/README.md
@@ -133,3 +133,10 @@ Options:
   --rex-user=REMOTE_EXEC_USER
                         Local user used by Foreman's remote execution feature.
 ~~~
+
+# For developers:
+
+Use `pydoc ./bootstrap.py` to get the code documentation.
+
+Use `awk -F\#\# 'NF>1 {print $2}' ./bootstrap.py` to see the flow of the script.
+