Skip to content
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

Closed
edwardhartnett opened this issue Sep 29, 2020 · 3 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@edwardhartnett
Copy link
Contributor

edwardhartnett commented Sep 29, 2020

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 edwardhartnett added this to To do in Version 1.3.0 Sep 29, 2020
@edwardhartnett edwardhartnett changed the title All NCEPLIBS should have good README All NCEPLIBS should have similar README with these standard sections Sep 29, 2020
@edwardhartnett
Copy link
Contributor Author

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
Copy link
Contributor Author

@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 edwardhartnett added this to To do in Version 1.4.0 via automation Dec 2, 2020
@edwardhartnett edwardhartnett removed this from In progress in Version 1.3.0 Dec 2, 2020
@edwardhartnett edwardhartnett self-assigned this Dec 4, 2020
@edwardhartnett edwardhartnett added the documentation Improvements or additions to documentation label Dec 4, 2020
@edwardhartnett
Copy link
Contributor Author

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

Version 1.4.0 automation moved this from To do to Done Dec 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant