We have some concerns that some of the README content are missing some sections which might be helpful when/if you would like to use them in demos. Installation is generally not a problem (due to pipeline), but once you install one of the more complicated projects, it is sometimes difficult to understand what features and functionalities have been implemented and the best way to demo them to others.
In order to solve this problem and also to put some structure to the READMEs, it is proposed that we create a template to guarantee consistent information in our READMEs.
yuriylesyuk
commented
3 years ago
We have some concerns that some of the README content are missing some sections which might be helpful when/if you would like to use them in demos. Installation is generally not a problem (due to pipeline), but once you install one of the more complicated projects, it is sometimes difficult to understand what features and functionalities have been implemented and the best way to demo them to others.
In order to solve this problem and also to put some structure to the READMEs, it is proposed that we create a template to guarantee consistent information in our READMEs.