search

NOAA-GFDL / fre-cli

Python-based command line interface for FRE (FMS Runtime Environment) to compile and run FMS-based models and post-process their output.
GNU Lesser General Public License v3.0
3 stars 7 forks source link

FRE-CLI Tools README documentation #144

Open singhd789 opened 1 month ago

singhd789 commented 1 month ago

Is your feature request related to a problem? Please describe. We should have READMEs with each tool to describe functionality, subtools, and how to use them.

Describe the solution you'd like The README for each tool could explain the function of the tool and list the subtools associated with it, along with a blurb about what each subtool does and maybe what variables/options/arguments are needed for it. An example of what it could look like can be seen in the fre make tool: https://github.com/NOAA-GFDL/fre-cli/tree/main/fre/make

It could also have a quickstart of how to use the tool/subtools.

ceblanton commented 1 month ago

Great idea. how can we connect these per-tool README's to the automatically generated github.io documentation page?

https://noaa-gfdl.github.io/fre-cli/index.html

singhd789 commented 1 month ago

@ceblanton Ooo good thought, thanks! I think I'll have to talk to Cihiem about the sphinx document builds