You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 16, 2021. It is now read-only.
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
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
start with
Or perhaps some of the info could be moved into an INITIAL-INSTALL.md or STARTERKIT.md, while the main README.md would focus
The text was updated successfully, but these errors were encountered: