README.md template for Berty projects

[moul]

The goal of this issue is to share ideas about the organization of our README files and potentially create an easy-to-use template

---

My initial idea of layout:

• have a generic header
  • logo
  • repo badges
  • community links (use badges?)
• body
  • short head-line that fits in a tweet
  • quick intro that can be read by a non-tech, explaining what this project is about
  • optional quick "clarification" intro for techs
  • optional how-to use (for a non-dev)
  • optional how-to dev (for dev)
  • optional how-to contribute (for non-dev)
• have a generic footer
  • maintainers section
  • contributing/community section
  • licensing section

---

Also, does it make sense to use an existing standard, if yes, which one(s) and why? In any case, what cool ideas can we steal from those standards?

Any concerns about using smileys on sections?

Also, I think that we should write the CODE_OF_CONDUCT.md file, and maybe other common files only in this repository; and then use links to this repo

---

Draft document here: https://hackmd.io/28Ipo7jhQAOaZW12-FN1-g?edit