Skip to content

Creating an Organization README

Amal-B-10 edited this page Feb 5, 2026 · 2 revisions

Setup steps

1. Create the .github repository

  • In the organization space (not a personal account).
  • Create a new repository named .github.
  • Set the repository to public (required for the README to be displayed).
  • Initialize the repository with a README (optional but recommended).

2. Create the organization README

  • Inside the .github repository, create the following structure:
.github/
└── profile/
    └── README.md
  • The README.md file located in the profile folder is automatically recognized by GitHub as the organization profile README.*

3. Write the content

  • The content of profile/README.md is written in Markdown and may include:
  • A presentation of the organization.
  • A list or description of projects.
  • Technologies used.
  • Links to main repositories.
  • Contact or contribution information.
  • No additional configuration is required.

Clone this wiki locally