在GitHub官网上如何记录项目

良好的文档是任何项目成功的关键。使文档可访问使人们能够了解项目; 使更新变得容易，确保文档保持相关性。
记录项目的两种常用方法是README文件和wiki：
README文件是其他用户更快速，更简单地了解您的工作的方法。
GitHub上的Wiki可帮助您以有用的方式提供有关项目的深入信息。
至少在你的项目中有一个README是个好主意，因为这是许多人第一次找到你的作品时会读到的东西。
创建自述文件
当你创建一个新的存储库，虽然GitHub上，选择“初始化这个资源库和自述”，除非你打算导入现有的资源库。 您的README.md文件现在可以在全新的存储库中进行编辑。您的项目名称位于顶部，后面是您在创建存储库时选择包含的任何描述。自述文件很容易在GitHub或本地修改。查看Mastering Markdown指南，了解有关如何在创建文件后修改文本的详细信息。
格式化README
自述文件通常遵循一种格式，以便立即将开发人员定位到项目的最重要方面。
项目名称：您的项目名称是人们在向下滚动到自述文件时会看到的第一个名称，并且在创建自述文件时包含在内。
描述：您的项目描述如下。一个好的描述是清楚，简短，重点。描述项目的重要性及其作用。
目录：可选地，包括一个目录，以便其他人快速浏览特别长或详细的自述文件。
安装：安装是有效自述文件的下一部分。告诉其他用户如何在本地安装项目。（可选）包含一个gif，以使其他人更清楚。
用法：下一部分是用法，在其中指导其他人在安装项目后如何使用项目。这也是一个包含项目截图的好地方。
贡献：较大的项目通常有关于为其项目做出贡献的部分，其中概述了贡献说明。有时，这是一个单独的文件。如果您有特定的贡献偏好，请解释它们，以便其他开发人员知道如何最好地为您的工作做出贡献。要了解有关如何帮助其他人贡献的更多信息，请查看为存储库贡献者设置指南的指南。
学分：包括学分部分，以突出显示并链接到您项目的作者。
许可证：最后，包括项目许可证的部分。有关选择许可证的更多信息，请查看GitHub的许可指南！
您的自述文件应仅包含开发人员开始使用和为您的项目做出贡献的必要信息。更长的文档最适合wiki，如下所述。
创建你的wiki
GitHub上的每个存储库都附带一个wiki。创建存储库后，您可以通过侧栏导航设置包含的Wiki。启动维基只需单击维基按钮并创建第一页即可。