readme in progress

fre/fre.py

@@ -209,7 +209,6 @@ def fremakefunction(context, yamlfile, platform, target, force_checkout, force_c
               is_flag=True,
               help="Get verbose messages (repeat the option to increase verbosity level)")
 @click.pass_context
-
 def create_checkout(context,yamlfile,platform,target,no_parallel_checkout,jobs,execute,verbose):
     """ - Write the checkout script """
     context.forward(fremake.fremake.ccheckout)
@@ -246,7 +245,6 @@ def create_checkout(context,yamlfile,platform,target,no_parallel_checkout,jobs,e
               is_flag=True,
               help="Get verbose messages (repeat the option to increase verbosity level)")
 @click.pass_context
-
 def run_checkout(context,yamlfile,platform,target,no_parallel_checkout,jobs,verbose):
     """ - Run the checkout script """
     context.forward(fremake.fremake.rcheckout)

fre/fremake/README-fremake.md

@@ -0,0 +1,16 @@
+# **Fremake Canopy**
+
+Through the fre-cli, `fre make` can be used to create and run a code checkout script and compile a model.
+
+## **Usage (Users)**
+
+* Refer to fre-cli README.md for foundational fre-cli usage guide and tips.
+
+### **Subtools Guide**
+
+1)  **fre make**
+    - configure
+        - Postprocessing yaml configuration
+        - Minimal Syntax: `fre pp configure -y [user-edit yaml file]`
+        - Module(s) needed: n/a
+        - Example: `fre pp configure -y /home/$user/pp/ue2/user-edits/edits.yaml`