Create a README for your enterprise

You can create a README to communicate important information and resources with members in your enterprise.

En este artículo

About READMEs for enterprises

Para ayudar a las personas a comprender lo que sucede en su empresa, debe crear un archivo LÉAME. Por ejemplo, puede usar un archivo LÉAME para ayudar a los miembros a obtener información sobre diferentes organizaciones de la empresa, compartir vínculos a recursos importantes o comunicar información sobre la configuración y las directivas de su empresa.

The README is displayed on the enterprise's "Overview" page, which is the landing page you see when you navigate to the enterprise. This page is only visible to members of the enterprise.

You can also create READMEs for organizations in your enterprise, visible either publicly or only to members. For more information, see Personalizar el perfil de tu organización.

Creating a README for an enterprise

  1. En la esquina superior derecha de GitHub, haz clic en la fotografía del perfil.

  2. En función de tu entorno, haz clic en Your enterpriseo en Your enterprises y, a continuación, haz clic en la empresa que deseas ver.

  3. On the "Overview" page, click Create README. If a README is already present on the page, click Edit.

  4. Write the content for your README. You can use Markdown to format the content, such as adding headings, images, and lists. For more information, see Sintaxis de escritura y formato básicos.

    Note

    You can only link to publicly hosted images in your README. You cannot upload an image to your README, or link to an image from a private repository.

  5. Click Save.

Further reading