re: How to write a good README? #discuss VIEW POST

re: I like this as a standard, but I'd make a few quick changes if I were managing a very grand-scale project: Move the license out to a separate fil...
  • 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.

code of conduct - report abuse