DEV Community

Discussion on: How to write a good README? #discuss

Collapse
 
sudiukil profile image
Quentin Sonrel
  • I actually put the full license in a dedicated file and the "license" section of the README only contains a link to it. That's probably a bit redundant but it's an old habit from the time when GitHub did not include the license in the project page header.

  • That's usually something I put in the full documentation to keep the README more lightweight and free of unnecessary technical details.