Skip to main content

为企业创建 README

可以创建一个 README,告知成员企业中正在发生的事件。

谁可以使用此功能?

Enterprise owners can create and edit an enterprise README.

关于企业的 README

为了帮助人们了解你的企业正在发生的事情,应该创建一个 README。 例如,可以使用 README 帮助成员了解企业中的不同组织、共享重要资源的链接或交流有关企业设置和策略的信息。

README 显示在企业的“概述”页面上,这是在导航到企业时看到的登陆页面。 该页面仅对企业成员可见。

还可以为企业中的组织创建公开或仅对成员可见的 README。 有关详细信息,请参阅“自定义组织的配置文件”。

为企业创建 README

  1. 在 GitHub Enterprise Server 的右上角,单击你的个人资料照片,然后单击“企业设置”****。

    单击 GitHub Enterprise Server 上的个人资料照片时显示的下拉菜单的屏幕截图。 “企业设置”选项以深橙色边框突出显示。

  2. 在“概述”页面上,单击“创建 README”。 如果页面上已存在 README,请单击“编辑”。

  3. 为 README 编写内容。 可以使用 Markdown 设置内容的格式,例如添加标题、图像和列表。 有关详细信息,请参阅“基本撰写和格式语法”。

    Note

    只能链接到 README 文件中的公开托管映像。 无法将映像上传到 README 文件,也不能从专用存储库链接到映像。

  4. 单击“ 保存”。

延伸阅读