关于企业的 README
关于README文件:在企业环境中,README文件用于向团队成员提供项目的总体概述、特定的使用指南以及相关的重要信息。README文件有助于确保所有参与者对项目有一致的理解和清晰的沟通。
README 显示在企业的“概述”页面上,此页面是在你导航到企业时看到的登陆页面。 该页面仅对企业成员可见。
还可以为企业中的组织创建公开或仅对成员可见的 README。 有关详细信息,请参阅“自定义组织的配置文件”。
为企业创建 README
-
在“概述”页面上,单击“创建 README”。 如果页面上已存在 README,请单击“编辑”。
-
为 README 编写内容。 可以使用 Markdown 设置内容的格式,例如添加标题、图像和列表。 有关详细信息,请参阅“基本写作和格式语法”。
注意
只能链接到 README 文件中的公开托管映像。 无法将映像上传到 README 文件,也不能从专用存储库链接到映像。
-
单击“ 保存”。
其他阅读材料
-
[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes) -
[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)