Comments (3)
I don't think that this is a necessary section for most packages; most already have a very clear way of installing them through a package manager, which clears up the majority of the requirements. I think that this belongs in the Install
section, as it most relevant there. The current specification outlines this:
### Install
**Status:** Required by default, optional for doc modules.
**Requirements:**
- Code block illustrating how to install.
**Subsections:**
- `Dependencies`. Required if there are unusual dependencies or dependencies that must be manually installed.
- `Updating`. Optional.
**Suggestions:**
- Link to prerequisite sites for programming language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
- Include any system-specific information needed for installation.
- If there is no code in the module - for instance, a document-based module - this section is not required.
Do you think this ought to be changed?
from standard-readme.
I don't think that this is a necessary section for most packages; most already have a very clear way of installing them through a package manager, which clears up the majority of the requirements.
Not so sure about that. I know in javascript-land, it's important to know which nodejs version + which npm version that the module supports, in some cases on which OS the module can be run and also if it supports the nodejs environment and browser, or just one of them. Sometimes, some modules also have peer dependencies ("you need this package, but it's not included here").
Same goes for Python, where the version split between 2 and 3 is significant. About go, not sure about that...
However, I did miss that the requirements
already was a part of the install, I think that's good enough since its already covered.
from standard-readme.
However, I did miss that the requirements already was a part of the install, I think that's good enough since its already covered.
Perhaps I could make this more prominent, by adding it as an optional subsection?
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.