Создание README для предприятия

Вы можете создать README, чтобы сообщить участникам, что происходит в вашей организации.

Кто может использовать эту функцию?

Enterprise owners can create and edit an enterprise README.

В этой статье

Сведения о READMEs для предприятий

Чтобы помочь людям понять, что происходит в вашей организации, необходимо создать README. Например, вы можете использовать README, чтобы помочь участникам узнать о различных организациях предприятия, поделиться ссылками на важные ресурсы или сообщить сведения о параметрах и политиках вашего предприятия.

ReadME отображается на странице "Обзор" предприятия, которая является целевой страницей, которая отображается при переходе к организации. Эта страница отображается только членам предприятия.

Вы также можете создавать readMEs для организаций в организации, видимые как общедоступными, так и только участниками. Дополнительные сведения см. в разделе Настройка профиля вашей организации.

Создание README для предприятия

  1. В правом верхнем углу GitHubщелкните фото профиля.

  2. В зависимости от среды щелкните "Ваше предприятие **" или выберите **"Предприятия **", а затем выберите **предприятие, которое вы хотите просмотреть.

  3. На странице "Обзор" нажмите кнопку "Создать README". Если на странице уже присутствует README, нажмите кнопку "Изменить".

  4. Напишите содержимое для README. Вы можете использовать Markdown для форматирования содержимого, например добавления заголовков, изображений и списков. Дополнительные сведения см. в разделе Базовый синтаксис записи и форматирования.

    Note

    Вы можете ссылаться только на общедоступные изображения в README. Вы не можете передать изображение в README или связать его с изображением из частного репозитория.

  5. Нажмите кнопку Сохранить.

Дополнительные материалы