acho01 / readme-manifesto

Manifesto for README Files in Software Development
https://www.readmemanifesto.org/
0 stars 1 forks source link

Adding pre-requisites #1

Closed nikasakandelidze closed 4 months ago

nikasakandelidze commented 4 months ago

For most of the projects, you can't dierctly start with installation guide. Since to run even "npm install" you need to at first have a specific version of nodejs installed on your local machine.

Another common case is also that, most of the projects (at least backend ones) have dependencies on some infrastructure parts(like db-s, message brokers, etc) so usually having already pre-built docker-compose file to "take care" of all the local infrastructure needs is a "best practice" so usually listing specific version of docker & docker-compose is also a must, i'd say.

*Using specific versions of every software artifact can't be under estimated, it's very important to have correct nodejs version running in case of having js backend project and so on.

acho01 commented 4 months ago

nice, lgtm