update readme to reflect IMPROVE

isaqb-org / curriculum-improve

Curriculum for the CPSA-advanced module IMPROVE

4 stars 2 forks source link

update readme to reflect IMPROVE #7

Closed gernotstarke closed 5 years ago

gernotstarke commented 5 years ago

currently it's partially copied from the template...

feststelltaste commented 5 years ago

I would suggest to only change the heading "How to use this template" to "How to build this document". I left out the other content from the "advanced-template" intentionally to avoid duplication.

programming-wolf commented 5 years ago

Parts of the README are supposed to stay the same across all advanced curricula.

gernotstarke commented 5 years ago

the constant parts across several curricula should be (imho):

[ ] where to download the generated docs
[ ] how to build
[ ] how to contribute
[ ] release process
[ ] iSAQB contact info
[ ] license and copyright

sections in readme with identical title but specific content

[ ] maintainers
[ ] contributors

I open a corresponding issue in the "advanced-template" repo :-)

gernotstarke commented 5 years ago

good enough for now, closed.