Skip to main content

Create a README for your enterprise

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

About READMEs for enterprises

Pour aider les gens à comprendre la situation de votre entreprise, vous devriez créer un LISEZMOI. Par exemple, vous pouvez utiliser un LISEZMOI pour aider les membres à découvrir différentes organisations de l’entreprise, à partager des liens vers des ressources importantes ou à communiquer des informations sur les paramètres et les stratégies de votre entreprise.

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 Personnalisation du profil de votre organisation.

Creating a README for an enterprise

  1. Dans le coin supérieur droit de GitHub, cliquez sur votre photo de profil.

  2. En fonction de votre environnement, cliquez sur Votre entreprise ou sur Vos entreprises, puis cliquez sur l'entreprise que vous souhaitez consulter.

  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 Syntaxe de base pour l’écriture et la mise en forme.

    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