News for hackers. Stuff that matters.

A comment on Resumes are dangerous?. Parent comment

Re:Resumes are dangerous? by theshrike79 on Monday April 25, 2022 @03:04PM (#31159242)
Adding a README.md isn't just GitHub specific, it's a good idea to add it to any project you do.

My memory sucks, that's why I write down what I'm planning to do with a project into the readme. It doesn't need to be super fancy with images and status badges and all that jazz.

This is perfectly enough:

  projectname
  ===========

  This fizzes

  TODO
  ----

  Add buzzing later
  Check if bazzing library is ready for production
[ Parent | on HN ]
Re:Resumes are dangerous? by rileymat2 on Monday April 25, 2022 @07:20PM (#31162128)
This is true, README has a long history.

However, I strongly associate Readme.md, designed for a web based intro view with Github.

It would be interesting to get the real history, because it could be a fluke of timing.

I’d bet if we look back at old source forge projects created pre-github there would be a strong correlation with the markdown version added and the rise of github. (Of course this could be a timing fluke)

[ Parent | on HN ]
Re:Resumes are dangerous? by theshrike79 on Tuesday April 26, 2022 @01:28AM (#31164258)
Markdown was invented around 2004, Github was founded in 2008.
[ Parent | on HN ]
Re:Resumes are dangerous? by rileymat2 on Tuesday April 26, 2022 @05:27AM (#31165486)
Which means you may be able to see a correlated acceleration in usage.
[ Parent | on HN ]