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

Added optionality to required things

Browse Source
This commit is contained in:
Richard Littauer 2016-07-28 13:55:41 -04:00
parent f92456b01f
commit c555f1f5d2
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spec.md
View File

@ -68,7 +68,7 @@ progressively greater amount of knowledge."
#### Table of Contents
**Status:** Required.
**Status:** Required by default, optional for READMEs less than 100 lines.
**Requirements:**
- 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.
@ -90,7 +90,7 @@ progressively greater amount of knowledge."
- Cover intellecutal provenance: A `See Also` section is also fitting.
#### Install
**Status:** Required.
**Status:** Required by default, optional for doc modules.
**Requirements:**
- Code block illustrating how to install.
@ -105,7 +105,7 @@ Subsections:
- If there is no code in the module - for instance, a document-based module - this section is not required.
#### Usage
**Status:** Required.
**Status:** Required by default, optional for doc modules.
**Requirements:**
- Code block illustrating common usage.
- If CLI compatible, code block indicating common usage.