Skip to content
This repository has been archived by the owner on Nov 16, 2021. It is now read-only.

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

Open
donquixote opened this issue Jan 9, 2020 · 0 comments

Comments

@donquixote
Copy link

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:

  • The project was just installed from https://github.com/openeuropa/drupal-site-template, and now the developer needs to do some initial steps.
  • The initial steps are done and this is now a full self-contained website project. The developer looking at the README cloned the project from its own repo on github, and is no longer concerned with the initial installer steps. Some parts of the current README no longer apply, and other information should be added.

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant