Comments (8)
Cool. Reopen if more discussion happens; at some point, I've got to stop bikeshedding - doesn't mean I am stopping conversation, though. :)
from standard-readme.
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.
from standard-readme.
:) No! These are good questions. I just think that the redundancy is super useful here.
from standard-readme.
Related: zcei/standard-readme#4 (TL;DR: Probably not required by law, but user friendly).
from standard-readme.
TL;DR: Probably not required by law, but user friendly
Sums it up for me.
from standard-readme.
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.
from standard-readme.
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.
from standard-readme.
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
from standard-readme.
Related Issues (20)
- Improvement in License section HOT 1
- Question on Usage section HOT 1
- Question: clarifying on rules for install, usage, and contributing HOT 3
- Installation fails because of missing dependency to opencollective-postinstall HOT 1
- README.cn.md doesn't follow naming convention HOT 8
- Introduce REUSE compliance/compatibility HOT 1
- 您好,能写一个新手能看懂的教程吗?
- cat: spec.md: No such file or directory HOT 1
- README, Markdown and other formats HOT 1
- It's a good markdown file HOT 1
- Create a logo for Open Collective
- The "Install" section may not seem right for deployable websites HOT 2
- Does this project comply with standard-readme HOT 1
- Table of Contents Built in to GitHub HOT 2
- Demo
- Some links in the maximal example are broken HOT 4
- Add support for CHANGELOG.md? HOT 2
- Add a Credits/Thanks/Acknowledgements section HOT 6
- Examples use "contributing" which results in an error HOT 3
- Chinese translation HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from standard-readme.