search

yet-another-user / pimpl

The C++ Pimpl Idiom Again!
36 stars 7 forks source link

Repository description is not the best choice #4

Closed eyalroz closed 3 years ago

eyalroz commented 7 years ago

It seems like you've chose the explanation of what the pimpl concept is, or what its motivation is, as the front-page repository description. I think that's the wrong choice, since the description should explain, even if briefly,

... and you don't get that from the existing text. Now, I really like this repo, but I would not have guessed that would be the case by reading its description.

yet-another-user commented 7 years ago

Thank you for the input. Happy to hear you like the repo. Appreciated. As for the description, then you might have a valid point and I do agree it could be better. Still, IMO spending time and effort on README seems to have very little ROI (return-on-investment). Hardly anyone reads it... You did not get here because of the README, right?.. And README did not deter you from looking at the actual code, right? Hard-core coders will jump to the source. Those, who want to learn/talk about it, will go to read the docs. So, README seems fairly superfluous. That is, IMO it does not serve any real purpose... just cosmetics IMO. You are certainly free to disagree. No drama.

eyalroz commented 6 years ago

The README.md is the main and probably only thing people see if they get to this repo not by some specific link which tells them what to expect. If someone looks at some other repo of yours and wants to see what else you've done - that's what s/he will look at. Or if you come up on some github search. Of course - your repo, your call...