在哪个文件中，我将安装步骤放入我的git存储库？

Question

我有一个git存储库，我想添加使项目在本地工作所需的安装步骤。该项目是一个公司和私人项目，用户也将是贡献者。我在用GitLab。

但我不知道在哪个文件里写这些步骤。我有几种选择，例如：

• README.md文件:它是用户和贡献者将看到的默认页面。但我担心一个文件中太多的信息会使人难以阅读。
• CONTRIBUTING.md文件:在我的例子中，将安装该项目的人将是贡献者。如果他们想作出贡献，他们将需要在本地安装该项目。
• INSTALL.md文件: GitLab无法将其识别为CONTRIBUTING和README。但更明显的是，它包含安装步骤。

在这种情况下，最佳做法是什么？

Answer 1

我喜欢在项目中看到INSTALL.md。如果我在想“我该如何安装这个？”那么INSTALL.md显然是个值得一看的地方。

在README.md中，添加一小部分有关安装的内容，并基本上将用户指向GitLab中托管的INSTALL.md文件：

关于项目..。贡献..。安装说明请参见INSTALL.md获得完整说明。

这给了你最好的两个世界。您可以从在GitLab中呈现的自述文件获得一个适当命名的文件和一个链接到适当命名的文件。

事实上，这将适用于GitHub、Azure DevOps或对自述文件进行特殊处理的任何其他git宿主解决方案。