The top-level README file is generated by a script scripts/generate_readme.sh and has to be run manually whenever changes are made to the markdown documents it concatenated together. This should be automated.
Action
Do one of:
create a pre-commit hook that runs scripts/generate_readme.sh and git adds the README before every commit
create a post-save hook for all documents included in the README that runs scripts/generate_readme.sh on each save
Context
The top-level README file is generated by a script
scripts/generate_readme.shand has to be run manually whenever changes are made to the markdown documents it concatenated together. This should be automated.Action
Do one of:
scripts/generate_readme.shandgit adds the README before every commitscripts/generate_readme.shon each save