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

Merge pull request #23 from RichardLitt/feature/remove-install-usage

Browse Source 
Make install and usage optional for doc repos
This commit is contained in:
Richard Littauer 2016-07-29 08:25:11 -04:00 committed by GitHub
commit a6c15b6b3e
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spec.md
View File

@ -68,7 +68,7 @@ progressively greater amount of knowledge."
#### Table of Contents #### Table of Contents
**Status:** Required. **Status:** Required by default, optional for READMEs less than 100 lines.
**Requirements:** **Requirements:**
- Must link to all Markdown sections in the file. - Must link to all Markdown sections in the file.
- Must start with the next section; do not include the title or Table of Contents headings. - Must start with the next section; do not include the title or Table of Contents headings.
@ -90,7 +90,7 @@ progressively greater amount of knowledge."
- Cover intellecutal provenance: A `See Also` section is also fitting. - Cover intellecutal provenance: A `See Also` section is also fitting.
#### Install #### Install
**Status:** Required. **Status:** Required by default, optional for doc modules.
**Requirements:** **Requirements:**
- Code block illustrating how to install. - Code block illustrating how to install.
@ -99,12 +99,13 @@ Subsections:
- `Updating`. Optional. - `Updating`. Optional.
**Suggestions:** **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. - Include any system-specific information needed for Installation.
- Subsection for dependencies needed for install to work. - 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 #### Usage
**Status:** Required. **Status:** Required by default, optional for doc modules.
**Requirements:** **Requirements:**
- Code block illustrating common usage. - Code block illustrating common usage.
- If CLI compatible, code block indicating common usage. - If CLI compatible, code block indicating common usage.
@ -116,6 +117,7 @@ Subsections:
**Suggestions:** **Suggestions:**
- Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here. - 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 #### Extra Sections
**Status**: Optional. **Status**: Optional.