I have a git repository and I would like to add the installation steps required to make the project work locally. The project is a company and private project and users will also be contributors. I'm using GitLab.
But I don't know in what file to write these steps. I have several options in mind such as:
README.mdfile: it's the default page that users and contributors will see. But I fear too much information inside one file will make it hard to read.
CONTRIBUTING.mdfile: in my case, people who will install the project will be contributors. If they want to contribute, they will need to install the project locally..
INSTALL.mdfile: it's not recognized by GitLab as
READMEare. But it's far more obvious in the name that it contains the installation steps.
What is the best practice in this case?