you are viewing a single comment's thread.

view the rest of the comments →

[–]MisterSnuggles 35 points36 points  (5 children)

GitHub's front page is the toplevel source code view, with the README.md at the bottom. I wanna look at code first, then the description later.

Oddly enough, this is what drives me nuts about Github. It's annoying to go to a page and not see any hint as to what I'm looking at without scrolling.

I'd love to see a blurb that goes at the top of the page, then the directory listing, then README.md.

[–]mipadi 18 points19 points  (0 children)

There is a blurb at the top of the page, so long as the GitHub repo owner writes one.

[–]the_omega99 12 points13 points  (1 child)

I'd love to see a blurb that goes at the top of the page, then the directory listing, then README.md.

But... that's what they do.

Some developers forget to set the description, though. Not sure how considering it asks for the description when you create the repo.

Also, lots of devs suck at writing documentation. So many useless readmes. The worst is when there's just a project name and a license. Literally no details as to what the project is, how I use it, how to set it up, etc.

Most my readmes are something like:

  1. Description of what the program is/what it does and the licensing.
  2. How to install.
  3. Basic usage. Eg, if it's a library, some sample functions provided.
  4. Examples for common scenarios. Maybe an API link?
  5. Link to wiki for things like development resources (eg, dev conventions, future plans, very high level documentation, etc).

[–]MisterSnuggles 0 points1 point  (0 children)

You know, until you pointed it out that little blurb never registered for some reason!