3 ms·
Isn't README.md the default view? If so, I'd assume you can include as much info about that project as you like in there.
by nkristoffersen 9y ago
Isn't README.md the default view? If so, I'd assume you can include as much info about that project as you like in there.
- shurcooL 9y agoSort of. The default view is the root directory listing, followed by the README. If your root directory happens to contain many files, the README will be below the fold. E.g., look at https://github.com/camlistore/go4 https://github.com/camlistore/go4. Unless your monitor height is 1600 px and you're using 90% browser zoom, you might not even see the README until you scroll down.
- goerz 9y agoThat's why I tend to link to the anchor of the README title, if I can, e.g. https://github.com/ibm/type#ibm-type https://github.com/ibm/type#ibm-type Something I picked up from @jsvine, who pointed out that when they open-source their data stuff from BuzzFeed, it makes it much more accessible for the general public when the first thing they see is not the code view.
- shurcooL 9y agoYeah, me too. You can also link to #readme, which is a generic tag at the very top of the README and is guaranteed to exist in every github repo. E.g.: https://github.com/ibm/type#readme https://github.com/ibm/type#readme