3 ms·
I see what you're saying, but I think there are two major use cases for Github, one where the README should be first, and one where it should be last. The first
by jdminhbg 8y ago
I see what you're saying, but I think there are two major use cases for Github, one where the README should be first, and one where it should be last. The first is yours, visiting a repo, which often serves as de facto homepage for a project. The second though, is for projects you contribute to or use frequently, where finding out what's new or navigating to particular piece of code is the most important task. I'm not sure what a good way of distinguishing between the two would be.
- sc11 8y ago> I'm not sure what a good way of distinguishing between the two would be. GitHub Pages makes it easy to create a separate website for the first use case, which you can link to on the very top in the description. Then the README can contain info aimed at (new) developers of the project, build instructions and the likes, which you likely don't have to go to frequently (your 2nd case).