Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

License Section #14

Closed
RichardLitt opened this issue May 27, 2016 · 8 comments
Closed

License Section #14

RichardLitt opened this issue May 27, 2016 · 8 comments

Comments

@RichardLitt
Copy link
Owner

@tunnckoCore, here:

And second I also don't have License section, because it 1) can be accessed directly by opening the LICENSE file from file browser, or 2) by clicking the badge which is next to the name of the repo (h1). I think it is more faster than scrolling to the end of big/small readmes. Look at mukla's or hybridify's current/latest readme using verb 0.9. :)

If you are lawyer or such, or just you come to see the license, isn't it more natural to look is there a license file first and open it directly, instead of scrolling and etc? That's why I don't have license section. Also in the package's npm page have link to license based on license field in package.json.

I still think it is industry standard - at least in the Node community - to have a License note, and as it is the last element, I don't think it detracts. The README should be the sole source of information - it can link elsewhere (like to the LICENSE file), and I think this redundancy (which you are right, it is) is useful, in that regard. If I just cat the README, I should know the License without having to look in another file. Also, package.json is js-specific. I want standard-readme to be more than just javascript.

@wooorm
Copy link
Collaborator

wooorm commented May 27, 2016

Related: zcei/standard-readme#4 (TL;DR: Probably not required by law, but user friendly).

@RichardLitt
Copy link
Owner Author

TL;DR: Probably not required by law, but user friendly

Sums it up for me.

@tunnckoCore
Copy link

tunnckoCore commented May 27, 2016

If I just cat the README, I should know the License without having to look in another file.

good point, just forgot about that. hm.

@RichardLitt
Copy link
Owner Author

Cool. Reopen if more discussion happens; at some point, I've got to stop bikeshedding - doesn't mean I am stopping conversation, though. :)

@tunnckoCore
Copy link

tunnckoCore commented Jun 2, 2016

But one more thing. Why you'll cat the README and expect to have license header as last header, when you'll see the LICENSE file when ls. Just curious. Everything we need is good and logical mind.

@RichardLitt RichardLitt reopened this Jun 2, 2016
@RichardLitt
Copy link
Owner Author

Because that's an extra command. And because I think that the README should be a source of truth for this, too. It's often what one finds as the first point of entry - even before downloading the module, like on GitHub, where you have to click License to see the contents of the file.

@tunnckoCore
Copy link

In 90 or even 99% of the cases there's also license file in every repository, so you can directly cat it, not the readme, lol. But nevermind, i'm just thinking differently whole life :D

@RichardLitt
Copy link
Owner Author

:) No! These are good questions. I just think that the redundancy is super useful here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants