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

Github

Github Problem Overview

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.

Github Solutions

Solution 1 - Github

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

Solution 2 - Github

One thing I just tried that works is use the .md extension on the README file, so README.md and github is smart enough to display it using markdown (way better than plain text).

Categories
Recommended Github Solutions

Previous Solution:

iOS 7 and later: set status bar style per view controller

IosCocoa Touch

Next Solution:

Sublime Text 3: Drag & Drop, Move & Create a copy of files & folders

SublimetextSublimetext3

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionripper234View Question on Stackoverflow
Solution 1 - GithubLars BrinkhoffView Answer on Stackoverflow
Solution 2 - GithubrafaelbitenView Answer on Stackoverflow