CODEWITHSUNDEEP
githubmultilingual
IT-bob
IT-bob

Reputation: 328

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.)

Upvotes: 22

Views: 22915

Answers (2)

BAIMAM BOUKAR JEAN JACQUES
BAIMAM BOUKAR JEAN JACQUES

Reputation: 1746

Yeah. This is possible! Just add READMEs in other languages following thr W3C language conventions.

  • If for instance your repo supports also french, you would create a README-fr.md file, README-es for Spanish, etc..
  • Then you just add reference to other languages in your main REAMDE

You can check this ressource for more hints

Upvotes: 3

Mr. Alien
Mr. Alien

Reputation: 157394

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)

Upvotes: 20

Related Questions