Create a better Readme

Question

cereallarceny opened this issue 4 years ago · comments

Based on this readme template, we should improve our readmes across all OpenMined projects.

Alan Aboudib · Answer 1 · Wed May 20 2020 04:15:09 GMT+0800 (China Standard Time)

Thank you @cereallarceny . We will work on this. So does that suggest that extra sections are not recommended ?

Patrick Cason · Answer 2 · Thu May 21 2020 03:46:05 GMT+0800 (China Standard Time)

@em-blue and the writing team will be in touch with you on this issue.

You can totally have extra sections, but I'd highly suggest you think about the content hierarchy.

Emma Bluemke · Answer 3 · Thu May 21 2020 04:09:23 GMT+0800 (China Standard Time)

Extra sections are fine! It's more about making sure all the info on that template is there.

Alan Aboudib · Answer 4 · Thu May 21 2020 06:29:50 GMT+0800 (China Standard Time)

OK great then. We will work on that. Thank you ⚡

Nilansh Rajput · Answer 5 · Sun May 31 2020 19:10:56 GMT+0800 (China Standard Time)

@AlanAboudib I will start on this!

Alan Aboudib · Answer 6 · Mon Jun 01 2020 03:18:37 GMT+0800 (China Standard Time)

Alan Aboudib · Answer 7 · Mon Jul 20 2020 17:53:45 GMT+0800 (China Standard Time)