Update README files with advice from US-RSE-2024
Open
b4b
docs-loc:codebase
docs:update
documentation
- Dominant language
- Fortran
- Stars
- 352
- Forks
- 361
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
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
hcohoon@lbl.gov
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
Contributor guide
Assessment
This issue has not been assessed yet.