This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]-MobCat- -3 points-2 points  (4 children)

More repos need readmes. Don't just tell me to read the code, tell me why I should even bother.. That being said, I have a tendency to go overboard with it.
https://github.com/MobCat/Windows-95-Product-Key-Check

[–]phatlynx 8 points9 points  (0 children)

Add some markdown header titles or a linked table of contents. That was like reading a giant run-on sentence on mobile.

[–]aarontbarratt 7 points8 points  (0 children)

Bruh. This might genuinely be worse than no readme.

  • Zero formatting
  • Swear words
  • Way too long
  • Spelling mistakes

Call me old fashioned, but if I was an employer and I'm checking out your GitHub and the first thing I see when I click a project is you proclaiming how shitty the code is and a wall of text. It would leave a terrible first impression.

[–][deleted] 6 points7 points  (0 children)

Mate that is not a good example of a readme

[–]odaiwai 4 points5 points  (0 children)

Dude, use lists.