search

NOAA-EMC / NCEPLIBS

Top level repo containing submodules for NCEPLIBS and associated dependencies for superproject builds
Other
43 stars 18 forks source link

All NCEPLIBS should have similar README with these standard sections #120

Closed edwardhartnett closed 3 years ago

edwardhartnett commented 4 years ago

All the NCEPLIBS should have a README with the following sections:

Deprecation Status (if any) Part of NCEPLIBS (with link) Introduction (brief) Authors/Code Manager Link to full documentation Dependent libraries Build instructions (including for user machines without module commands) References Lawyers' disclaimers

edwardhartnett commented 4 years ago

BTW no need to have the version in the README. The README is on the master branch, so there is no version associated with it, you are being shown the current README. Also the versions of the most recent release can be see in the "Releases" section. No need to duplicate it, we will just get it wrong sometimes and forget to update, as here: https://github.com/NOAA-EMC/NCEPLIBS-bacio

edwardhartnett commented 4 years ago

@kgerheiser I just noticed the GitHub status badge here: https://github.com/NOAA-EMC/NCEPLIBS-sp

Neat!

This is accomplished in the README.md with this:

![Status](https://github.com/NOAA-EMC/NCEPLIBS-sp/workflows/Build%20and%20Test/badge.svg)

This is documented here: https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/adding-a-workflow-status-badge

I think we should have this in all the README.md files. @kgerheiser do you agree?

edwardhartnett commented 3 years ago

The READMEs are all now in pretty good shape. I will close this issue.