openeuropa / drupal-site-template

OpenEuropa template for Drupal sites.
European Union Public License 1.2
12 stars 10 forks source link

How to make README.md suitable for a self-contained project after initial install? #60

Open donquixote opened 4 years ago

donquixote commented 4 years ago

The initial installer command generates a README.md, which I think is just a copy of README.md.dist.

There are two scenarios when people look at this README:

I suspect that in many existing projects, the README was simply left as it is, or only some random changes were done.

Perhaps a section could be added to the README, suggesting changes one would typically make to the README. Also some placeholder text, like "insert project name here".

Perhaps some changes could already be done to the initial readme: E.g. instead of

This project starter kit will create a website using

start with

This project was created with the starter kit from https://github.com/openeuropa/drupal-site-template.

Or perhaps some of the info could be moved into an INITIAL-INSTALL.md or STARTERKIT.md, while the main README.md would focus