commit 64bfe91e9c99a3d3998626ddcfd30f34feebb8f4
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 61bc103b9082300e823030217c2899e8e87f0c04
parent b923b60c369fe3fce2a6f3b0bdf7c1d8c4ea6a6a

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