89 搜索结果 "readme"
REST API / 存储库 /
存储库内容的 REST API 终结点
"base64",
"size": 5362,
"name": "README.md",
"path": "README.md",
"content": "IyBZb2dhIEJvmsg
组织 / 与组协作 /
自定义组织的配置文件
可自定义组织的“概述”页,以显示专用于公共用户或组织成员的 README 和固定存储库。
登录到 GitHub 的组织成员可以在其访问组织的配置文件页面时选择 README 和固定存储库的 member 或 public 视图。
如果存在成员专用 README 或成员专用固定存储库,则视图默认为 member;否则为
存储库 / 管理存储库设置 / 自定义存储库 /
关于自述文件
您可以将自述文件添加到仓库,告知其他人您的项目为什么有用,他们可以对您的项目做什么,以及他们可以如何使用。
关于自述文件
您可以将 README 文件添加到仓库来交流有关您项目的重要信息。 自述文件以及存储库许可证、引文文件、贡献指南、行为准则传达了对项目的期望,并有助于管理贡献。
有关为项目提供指南的详细信息,请参阅
入门 / 开始你的旅程 /
将项目上传到 GitHub
"Public" if you want others to be able to see your project.
Select Add a README file. You will edit this file in a later step.
Click Create repository.
存储库 / 创建和管理存储库 /
存储库最佳做法
了解如何最有效地使用存储库。
创建 README 文件
为了便于用户理解和导航你的工作,建议为每个存储库创建一个 README 文件。
您可以将 README 文件添加到仓库来交流有关您项目的重要信息。 自述文件以及存储库许可证、引文文件、贡献指南、行为准则传达了对项目的期望,并有助于管理贡献。 有关详细信息,请参阅“关于自述文件”。
GitHub Issues / Projects / 了解 Projects /
Projects 的最佳做法
链接到相关的议题或拉取请求以沟通它们是如何连接的。
使用说明、README 和状态更新
使用您的项目描述和 README 来分享有关该项目的信息。
例如:
解释项目的目的。
描述项目视图及其使用方法。
包括相关链接和要联系的人员以获取更多信息。
项目 README 支持 Markdown,它允许您使用图像和高级格式,如链接、列表和标题。
GitHub Issues / Projects / 创建 projects /
创建 project
(可选)如果选择了模板,请查看将创建的字段、视图、工作流和见解。
在“项目名称”下的文本框中,键入新项目的名称。
单击“创建项目”。
更新项目描述和 README
你可以设置项目的说明和自述文件以共享项目的目的,提供有关如何使用该项目的说明,并包括任何相关链接。
导航到你的项目。
在右上角,单击
以打开菜单。
GitHub Issues / Projects / 了解 Projects /
Projects 快速入门
(可选)如果选择了模板,请查看将创建的字段、视图、工作流和见解。
在“项目名称”下的文本框中,键入新项目的名称。
单击“创建项目”。
设置项目描述和 README
你可以设置项目的说明和自述文件以共享项目的目的,提供有关如何使用该项目的说明,并包括任何相关链接。
导航到你的项目。
在右上角,单击
以打开菜单。
帐户和个人资料 / 配置文件 / 自定义个人资料 /
管理个人资料自述文件
可以向您的 GitHub 个人资料添加自述文件以向其他人介绍自己。
关于您的个人资料自述文件
可以通过创建个人资料 README,在 GitHub 上与社区分享有关你自己的信息。 GitHub 在个人资料页面的顶部显示您的个人资料自述文件。
您决定在个人资料自述文件中包含哪些信息,因此您可以完全控制如何在
存储库 / 创建和管理存储库 /
仓库快速入门
可以选择性地添加存储库的说明。 例如,“我在 GitHub 上的第一个仓库”。
选择仓库可见性。 有关详细信息,请参阅“关于仓库”。
选择“使用 README 初始化此存储库”。
单击“创建存储库”。
恭喜! 你已经成功创建了第一个存储库,并使用自述文件对其进行了初始化。
Note
若要详细了解 GitHub