guideline-readme:README.md 指南

时间:2024-06-24 11:06:57
【文件属性】:

文件名称:guideline-readme:README.md 指南

文件大小:1KB

文件格式:ZIP

更新时间:2024-06-24 11:06:57

指南自述文件 受启发的项目! README 应该简单而简短,但是一个好的 README 可以节省时间,尤其是当它用于诸如命令行参数解析库之类的东西时。 话题 项目和所有子模块和库的名称(有时它们的名称不同,新用户很容易混淆)。 所有项目、所有子模块和库的描述。 关于它如何使用的 5 行代码片段(如果它是一个库)。 版权和许可信息。 安装、配置和运行程序的说明。 其他联系信息(电子邮件地址、网站、公司名称、地址等)。 简要历史,如果它是其他东西的替代品或分支。 法律声明(加密的东西)。 句法 仅 ASCII 字符,如果 README 是用英文编写的。 如果可能的话,用英文写,并提供带有两个字母语言代码扩展名的翻译版本,如 README.pt。 每行不超过 80 个字符。 段落之间的单个空行。 标题下的破折号。 缩进使用空格 (0x20) 而不是制表符。


【文件预览】:
guideline-readme-master
----README.md(1KB)

网友评论