4 ms·
> Should the source code README explain what it is? Yes, at least one sentence at the top. Linking to a website containing several "something.sh" titles leadin
by voytec 2y ago
> Should the source code README explain what it is?
Yes, at least one sentence at the top. Linking to a website containing several "something.sh" titles leading to multiple pages with proper one-sentence descriptions is a silly treasure hunt.
I wasn't that interested, gave up after 2 pages and my take is still "they're re-using popular text editor's name, whatever this does".
- kbenson 2y agoI'm not sure why you think a single sentence at the top is better than a link to website that documents it, nor why you think it's the job of the source repo to explain what it is instead of how to build it. Sure, in some cases you might want that, but not every source repo is meant to be he onboarding location for people, where they learn what something is and what it's for. It's sort of like expecting assembly instructions to be full of marketing copy about why you want to use the product and why it was made. Presumably, when you're looking at the instruction manual, you're already past that point. Just because someone did the equivalent of handing you an instruction manual does not mean that instruction manual has a major shortcoming by not explaining all the wonderful ways the product it builds can help you. You were given the wrong material without context.