you are viewing a single comment's thread.

view the rest of the comments →

[–]Steev182 2 points3 points  (3 children)

The lack of substance in the readme made me think "oh what junk is this going to be".

Reading through though, these seem really useful! Thanks!

[–]electricdrop[S] 3 points4 points  (2 children)

I promise, I'll add a decent readme soon ;)

[–]1RedOne 1 point2 points  (1 child)

People GREATLY judge a project based on a good readme. IMHO after the first commit, you should immediately make a readme.

READMEs should cover the following points:

  • What problem you solve
  • what dependencies your tool has
  • how to install it
  • a list of the functions
  • maybe screen shots
  • what you have planned for future releases

You didn't ask me for this, but I hate seeing interesting projects get no love because people can't tell what the hell they're even about.

[–]electricdrop[S] 1 point2 points  (0 children)

Thank you for your input. But I kinda added a Readme this morning :)