Repo README.md files...

classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Repo README.md files...

jewzaam
Administrator
We have a standard file that has been copied for a while but there are some problems:
1) lots of the info in it are in the gitbooks
2) the dependencies listed are likely out of date
3) the dependencies listed are really for core, not for that specific package

So what should we have in those readme's?  I think at a minimum we should:
* briefly describe the repo
* reference the licence
* reference the hosted documentation
* include 3rd party licenses specific to that module (which could mean also transitive dependencies?)
Reply | Threaded
Open this post in threaded view
|

Re: Repo README.md files...

lcestari
Agree. I think we should avoid rework if we duplicate or put too much contetn on the README.md files as we should focus on the documentation. So I think the best README should be very summarized as possible, with only necessary things like Naveen mentioned.