search

NCAR / ccpp-framework

Common Community Physics Package (CCPP)
http://www.dtcenter.org/community-code/common-community-physics-package-ccpp/
Other
26 stars 64 forks source link

Update README.md, remove README_TODO.txt #425

Closed mkavulich closed 2 years ago

mkavulich commented 2 years ago

Update README.md, remove README_TODO.txt

Updating README.md to remove badly outdated information and add links to existing documentation elsewhere. Also, remove README_TODO.txt which is obsolete.

User interface changes?: No

Fixes: Partially addresses Github issue #400, we will need to decide whether capgen-specific documentation should go in the README or elsewhere before I'd consider that issue fully resolved.

Testing: None, edits to README files only.

grantfirl commented 2 years ago

Yes, thank you very much indeed!

@grantfirl we can either merge this right away and use one of the next CCPP PRs to advance the submodule pointer in fv3atm, or we can wait and follow the usual procedure. But this is completely safe to merge now.

Sure, let's merge now and I'll update the submodule pointer as part of the latest Thompson tuning ccpp-physics PR that will go in next week. I'm going to be doing the upstream PRs on that, so we won't need others' cooperation.

grantfirl commented 2 years ago

FYI, updated submodule pointer is here: https://github.com/NOAA-EMC/fv3atm/pull/463