只是想知道是否有针对此类事物的标准,特别是针对 debian 软件包。
我在这里看到了许可证,LICENSE.LGPL
我想添加一些安装说明,但不确定是否应该命名
INSTALL.txt
INSTALL.TXT
INSTALL
install.txt
install
README
readme.txt
... 你明白了。Debian 或 Ubuntu 肯定有这类东西的模板或标准,对吧?
答案1
没有必须遵循的特定标准。
自述和安装是分开的。一般来说,自述是描述包裹内容的内容,以及安装正在描述如何安装它。如果你使用 GNU autotools,它遵循以下方案:自述和安装文件。如果你有源代码GitHub,它期望自述文件.md采用 markdown 格式,它会使用该格式在项目树根处生成一些 HTML。您可以随意命名该文件。
如果您在项目中使用标准构建系统,那么通常很明显应该如何构建和安装包(假设源代码没有被与构建系统相矛盾的硬编码值破坏)。在某些情况下,可能需要解释可以提供哪些额外的标志构建例如,以不同于默认的方式配置包的各个部分。