-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
All NCEPLIBS should have similar README with these standard sections #120
Comments
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 |
@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:
This is documented here: I think we should have this in all the README.md files. @kgerheiser do you agree? |
The READMEs are all now in pretty good shape. I will close this issue. |
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
The text was updated successfully, but these errors were encountered: