4 ms·

Every new OSS repo's README should convince me to try it instead of the current standard tools, or at least compare it to them. In my case, I'd want to know wha

Every new OSS repo's README should convince me to try it instead of the current standard tools, or at least compare it to them. In my case, I'd want to know what makes it better than Vuex.

vitriol83 7y ago
That’s rather solipsistic
- kickopotomus 7y ago
  Rationale, motivations, project state etc. are all pretty relevant to any README. In the case of a library that solves a problem which already has known solutions, providing evidence of why your solution is better seems like a no-brainer.
  - vitriol83 7y ago
    They’re all very relevant, but I try not to expect the same from OSS projects as from a VC pitch deck. After all this is work given freely.
- nerdponx 7y ago
  On the contrary, it's too narrow. It shouldn't be limited to open source. IMO any program that isn't a hobby/learning/research project should justify its existence before expecting people to use it.
  - hombre_fatal 7y ago
    A more charitable way I prefer to phrase it: ostensibly you invested time and effort and then shared it with the goal of other people using it, so investing further efforts into the readme helps you achieve this goal even though it might not be as fun as writing code. It's like when someone shares their hobby programming language after investing 100s of hours of work yet didn't even invest 10 minutes writing a "quick start" heading of their readme. I would like to gently encourage them to reach for that low-hanging fruit that's so easy to overlook yet directly serves their goals.
- alexchamberlain 7y ago
  solipsistic - adjective. of or characterized by solipsism, or the theory that only the self exists, or can be proved to exist -- https://www.dictionary.com/browse/solipsistic https://www.dictionary.com/browse/solipsistic ... in case anyone else had to Google that
peterluhub 7y ago
It does have the key points listed in the readme. It probably is so obvious. Let me summarize them here. 1. Simplicity - The concepts of XSM are straightforward and easy to grasp. Whereas, the concepts of Vuex are not as easy to understand. 2. Vuex is for Vue only. On the other hand, XSM works Angular, React, and Vue. Learn once and be good with the 3 frameworks. Chance of code reuse with XSM.

Every new OSS repo's README should convince me to try it instead of the current standard tools, or at least compare it to them. In my case, I'd want to know what makes it better than Vuex.

vitriol83 7y ago

That’s rather solipsistic

kickopotomus 7y ago
Rationale, motivations, project state etc. are all pretty relevant to any README. In the case of a library that solves a problem which already has known solutions, providing evidence of why your solution is better seems like a no-brainer.
- vitriol83 7y ago
  They’re all very relevant, but I try not to expect the same from OSS projects as from a VC pitch deck. After all this is work given freely.
nerdponx 7y ago
On the contrary, it's too narrow. It shouldn't be limited to open source. IMO any program that isn't a hobby/learning/research project should justify its existence before expecting people to use it.
- hombre_fatal 7y ago
  A more charitable way I prefer to phrase it: ostensibly you invested time and effort and then shared it with the goal of other people using it, so investing further efforts into the readme helps you achieve this goal even though it might not be as fun as writing code. It's like when someone shares their hobby programming language after investing 100s of hours of work yet didn't even invest 10 minutes writing a "quick start" heading of their readme. I would like to gently encourage them to reach for that low-hanging fruit that's so easy to overlook yet directly serves their goals.
alexchamberlain 7y ago
solipsistic - adjective. of or characterized by solipsism, or the theory that only the self exists, or can be proved to exist -- https://www.dictionary.com/browse/solipsistic https://www.dictionary.com/browse/solipsistic ... in case anyone else had to Google that

peterluhub 7y ago

It does have the key points listed in the readme. It probably is so obvious. Let me summarize them here. 1. Simplicity - The concepts of XSM are straightforward and easy to grasp. Whereas, the concepts of Vuex are not as easy to understand. 2. Vuex is for Vue only. On the other hand, XSM works Angular, React, and Vue. Learn once and be good with the 3 frameworks. Chance of code reuse with XSM.