Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a way to create a folder-specific readme file in github?

Tags:

github

Github parses and displays a readme.txt or readme.md file at the root of the repository.

I would like to create a similar readme file for a particular folder. Is there a way to accomplish this?

One ugly hack I thought of was to name the file _readmeme.md causing it to appear as the first file in the folder, and making it easy for users to find and click it. - it doesn't work, _README appears last and not first.

like image 741
ripper234 Avatar asked Sep 26 '13 06:09

ripper234


People also ask

How do I add a README to a folder?

If you want to add a README to another folder, you can navigate to that folder and press the "Create new file" button. Just name the file README.md and you'll have the exact same editor available.

Can you create folders in a GitHub repository?

On GitHub you can do it this way: Go to the folder inside which you want to create another folder. Click on New file. On the text field for the file name, first write the folder name you want to create.

Can a repo have multiple README?

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.


1 Answers

GitHub already has this feature. Just put your README file in a subdirectory, and it will be displayed just like one in the root directory.

For example, see README.md for this subdirectory: http://github.com/larsbrinkhoff/lbForth/tree/master/targets

like image 123
Lars Brinkhoff Avatar answered Sep 29 '22 13:09

Lars Brinkhoff