From f4f5d9972db220082e1cfa8785d75eeb993d5c82 Mon Sep 17 00:00:00 2001 From: Bennett Chang Date: Tue, 2 Apr 2024 10:22:35 -0400 Subject: [PATCH] readme in progress --- fre/fre.py | 2 -- fre/fremake/README-fremake.md | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 fre/fremake/README-fremake.md diff --git a/fre/fre.py b/fre/fre.py index 86f3d735..5ea22ceb 100644 --- a/fre/fre.py +++ b/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) diff --git a/fre/fremake/README-fremake.md b/fre/fremake/README-fremake.md new file mode 100644 index 00000000..92fb04db --- /dev/null +++ b/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`