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.

Sign up for GitHub

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

Jump to bottom

Update README files with advice from US-RSE-2024 #2879

Open

ekluzek opened this issue Nov 14, 2024 · 0 comments

Labels

bfb documentation

Milestone

ctsm6.0.0 (code f...

Collaborator

ekluzek commented Nov 14, 2024 •

edited

Loading

There was a talk about research into improving project README files to make projects easier to use and more clear.

Here's some notes I took on this.

documenting research artifacts for reproducibility
Johanna Cohoon
[email protected]
for papers for example

root readmes should be the central point for everything describing the directory structure and other things needed all at the top level.

time estimates for build. run etc

ekluzek added documentation bfb labels

ekluzek added this to the ctsm6.0.0 (code freeze) milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment