commit 69c9df46a290b5c9a24a68ff76390687cde457ac
author sbconsulting <sbconsulting@users.noreply.github.com> Wed Apr 06 14:12:35 2016 -0700
committer sbconsulting <sbconsulting@users.noreply.github.com> Wed Apr 06 14:12:35 2016 -0700
tree 640161ca772db3dd6d41b644a87e9d869b6b991d
parent 42dabe0c7b83051aafaeda2c872e13c23e0e1bed

started a README.md, to have a place to document modelgen commands

xos/tools/README.md

diff --git a/xos/tools/README.md b/xos/tools/README.md
new file mode 100644
index 0000000..ef13848
--- /dev/null
+++ b/xos/tools/README.md
@@ -0,0 +1,9 @@
+## Overview of XOS tools
+
+### modelgen
+
+Modelgen reads the XOS models and applies those models to a template to generate output. 
+
+Examples:
+  * ./modelgen -a core api.template.py > ../../xos/xosapi.py            
+  * ./modelgen -a services.hpc -b Service -b User hpc-api.template.py > ../../xos/hpcapi.py