3 ms·
Because we’re not saying it often enough: Kudos to the author for going out of their way and writing meticulously detailed step-by-step instructions. That READ
by Hackbraten 4y ago
Because we’re not saying it often enough:
Kudos to the author for going out of their way and writing meticulously detailed step-by-step instructions.
That README shows a great deal of appreciation for other people’s time, which should be commended.
- robohoe 4y agoI personally like these detailed step by step readmes. It’s helpful for someone clueless dropping in to get quickly started and develop a working prototype. Too many times you’re left to your own devices when setting up dependencies. I totally understand if you’re expected to do some homework. On another hand, it certainly helps to gently guide the reader versus give them a high level request to install this or that.
- darkwater 4y agoOnce upon a time these were usually posts on one own blog (self-hosted or not), started with a HOWTO keyword and helped the people just in the same way. Nowadays everything developer must be on GitHub or it won't ever be noticed. /Old man yells at clouds
- lazyier 4y agoIt is an improvement. Having documentation include with source code means that they can updated together and is less likely to be out of date. Provided, of course, they don't use the github wiki stuff or use separate repos for documentation.
- zymhan 4y agoThere's probably something to be said for the easy of editing a markdown file and pushing it to github, versus using some crummy blog platform. In addition to the fact that folks can submit a PR (or fork) to update the instructions if something goes out of date.
- Qub3d 4y agoI host my blog using GitHub pages and hugo. Its all still markdown, but it also allows people to go to my vanity url and see stuff formatted exactly as I want it to be.
- martinflack 4y agoI read "This is an S, the letter, not a 5." and smiled... aaahhh, someone who's been deep in the trenches. ;-)