saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make install and usage optional for doc repos

Browse Source 
See https://github.com/RichardLitt/standard-readme/issues/21
This commit is contained in:
Richard Littauer 2016-07-27 17:22:47 -04:00
parent 494652c923
commit f92456b01f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spec.md
View File

@ -99,9 +99,10 @@ Subsections:
- `Updating`. Optional.
**Suggestions:**
- Link to prerequisite sites for language. [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
- Link to prerequisite sites for language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
- Include any system-specific information needed for Installation.
- Subsection for dependencies needed for install to work.
- If there is no code in the module - for instance, a document-based module - this section is not required.
#### Usage
**Status:** Required.
@ -116,6 +117,7 @@ Subsections:
**Suggestions:**
- Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here.
- If there is no code in the module - for instance, a document-based module - this section is not required.
#### Extra Sections
**Status**: Optional.