Add multiple README on GitHub repo

Question

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

What's the end result you want to achieve with this? GitHub will still parse the Markdown and render it properly, if that's your concern. — user247702, Nov 23 '17 at 14:32
It seems like it would be easy to just try this and see what happens... — whodini9, Nov 23 '17 at 14:34
@Stijn I want the visitor to be able to change easily between files, but on the main repo page. — IT-bob, Nov 23 '17 at 15:46
@user247702 he wants to see different file say readme1.md or readme2.md files, to just like how REAMME.md file looks at bootom after scroll repo page — Ashish Kamble, May 12 '20 at 08:15

score 19 · Accepted Answer · answered Nov 23 '17 at 14:33

19

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)

answered Nov 23 '17 at 14:33

Mr. Alien

153,751
34
298
278

Good idea! It's not exactly what I want, but it's okay. Thanks! – IT-bob Nov 23 '17 at 15:37
1

I know that's not what you're looking for but as of now there's no option for multiple languages either. – Mr. Alien Nov 23 '17 at 15:48
Do you just put the url or add any markdown as well? – Tigerware Jul 28 '21 at 04:29
1

Is this what you meant? https://github.com/jonatasemidio/multilanguage-readme-pattern – White_King Mar 31 '22 at 17:03

Add multiple README on GitHub repo

1 Answers1