Hacker News new | ask | show | jobs
by SnowLprd 4963 days ago
I'm amazed at the number of projects that don't have even the simplest description as to what problem the software purports to solve. This well-intentioned project strikes me as among the more egregious examples.

The README contains almost zero information as to why the project was created, which problems it aims to rectify, and why you might want to use it. That this information may or may not be contained in an embedded video is of no relevance to someone (like myself) who has neither the time nor ability at this particular moment to watch anything on video that could have been more succinctly explained in 2-3 sentences. It won't be bookmarked or favorited for later perusal -- just ignored.

Please understand I mean this as constructively as possible: it's hard to create something and share it with the world, and for that your efforts are most highly commended. I suggest adding a general introduction/description and some use cases to both the project site and README file. That will go a long way toward garnering the attention of those who might otherwise simply shrug and walk away.

1 comments

Thanks for the feedback. We should have done this a while ago. It's easy to forget that other people have no idea what we are building. Cheers.

https://github.com/freshshell/fresh/commit/4ebf599aa61b54b66... and https://github.com/freshshell/fresh/commit/000d7ce00b9029881...