How quantumnovice/awesome-civil-engineering works
This repository is a curated civil-engineering resource catalog, with a generator that validates structured catalog data and renders the README. Its main user workflow is browsing categorized resources in that README. A secondary workflow synchronizes GitHub contributors into the acknowledgements file. The README documents a broad range of engineering disciplines and tool types; the available source excerpts show the generator and contributor-sync implementation, but not the catalog data or template contents.
Main entry points: README.md Resource README · generate.py README generator · sync_contributors.py Contributor sync · resources.json Resource catalog data
Components 13
Resource catalog
- Resource README
README.md - Water resources
README.md - Structural engineering
README.md - Other disciplines
README.md - Practice tools
README.md - Programming resources
README.md
README generation
- Resource catalog data
data/resources.json - README generator
generate.py - README template
templates/README.md.j2
Contributor sync
- Contributor sync
sync_contributors.py - GitHub contributors API
- Contributor acknowledgements
contributing.md
Other components
- Catalog reader
Connections 11
- Catalog reader → Resource README: browses
README.md - Resource README → Water resources: lists
README.md - Resource README → Structural engineering: lists
README.md - Resource README → Other disciplines: lists
README.md - Resource README → Practice tools: lists
README.md - Resource README → Programming resources: lists
README.md - Resource catalog data → README generator: validates and loads
generate.py - README template → README generator: renders through
generate.py - README generator → Resource README: writes
generate.py - GitHub contributors API → Contributor sync: provides contributors
sync_contributors.py - Contributor sync → Contributor acknowledgements: updates
sync_contributors.py