Search code examples
githubmultilingualreadme

Add multiple README on GitHub repo

Is it possible to add multiple README on a git repository? To write a french and a english file for example (README.fr.md, README.en.md).

(Of course, I know it's possible but it's not recognized by GitHub as a README.)

Solution

  • Yes, you can add, but the default name of the base file should be README.md, and later, add the URLs of different languages on the top of the README.md file so that users can switch to other languages.

    Also, make sure that you add the language switch option in each of the README file so that user can switch the language back to the default which is English(I assume)