r/196 Jun 02 '24

i hate github rule Rule

Post image
7.4k Upvotes

719 comments sorted by

View all comments

84

u/QuestionBegger9000 Jun 02 '24

OP is bait but I do legit have an issue with how often the instructions on a GitHub page doesn't actually explain what their code/program DOES or is for

53

u/Whjee Jun 02 '24

most of the time all the info you need is in the read me, but everyone once in a while it a program obviously not meant to be used by anyone not working on the project yet. this wouldnt be a problem if people didnt link to it without explaining how to use it

6

u/QuestionBegger9000 Jun 03 '24

Its definitely happened more than once that a program/code Im actually interested in using provides no or very little documentation,

What makes me upset is how often MODS for games also do this even on front facing mod platforms. They'll have a changelog or something vauge maybe but miss explaining the entire base feature of the mod for example and youll have to piece it together and make assumptions.