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

Use a blank line to separate Status & Requirements

Browse Source 
Rather than invisible trailing whitespace.
This commit is contained in:
JesseWeinstein 2016-08-29 19:16:42 -07:00 committed by GitHub
parent 28c934ef62
commit bc28e71d1f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
spec.md
View File

@ -16,6 +16,7 @@ A compliant README must satisfy all the requirements listed below.
### Title ### Title
**Status:** Required. **Status:** Required.
**Requirements:** **Requirements:**
- Title must match repository and package manager names. If any of these don't match, there must be a note in the [Long Description](#long-description) explaining why. - Title must match repository and package manager names. If any of these don't match, there must be a note in the [Long Description](#long-description) explaining why.
@ -24,6 +25,7 @@ A compliant README must satisfy all the requirements listed below.
### Banner ### Banner
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Does not require its own title. - Does not require its own title.
- Must link to local image in current repository. - Must link to local image in current repository.
@ -31,6 +33,7 @@ A compliant README must satisfy all the requirements listed below.
### Badges ### Badges
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Does not require a title of its own. - Does not require a title of its own.
- Must be newline delimited. - Must be newline delimited.
@ -40,6 +43,7 @@ A compliant README must satisfy all the requirements listed below.
### Short Description ### Short Description
**Status:** Required. **Status:** Required.
**Requirements:** **Requirements:**
- Does not require its own title. - Does not require its own title.
- Must be less than 120 characters. - Must be less than 120 characters.
@ -54,6 +58,7 @@ A compliant README must satisfy all the requirements listed below.
### Long Description ### Long Description
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Does not require its own title. - Does not require its own title.
@ -74,6 +79,7 @@ progressively greater amount of knowledge."
### Table of Contents ### Table of Contents
**Status:** Required by default, optional for READMEs less than 100 lines. **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.
@ -84,11 +90,13 @@ progressively greater amount of knowledge."
### Security ### Security
**Status**: Optional. **Status**: Optional.
**Requirements:** **Requirements:**
- May go here if it is important to highlight security concerns. Otherwise, it should be in [Extra Sections](#extra-sections). - May go here if it is important to highlight security concerns. Otherwise, it should be in [Extra Sections](#extra-sections).
### Background ### Background
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Cover motivation. - Cover motivation.
- Cover abstract dependencies. - Cover abstract dependencies.
@ -96,6 +104,7 @@ progressively greater amount of knowledge."
### Install ### Install
**Status:** Required by default, optional for doc modules. **Status:** Required by default, optional for doc modules.
**Requirements:** **Requirements:**
- Code block illustrating how to install. - Code block illustrating how to install.
@ -110,6 +119,7 @@ progressively greater amount of knowledge."
### Usage ### Usage
**Status:** Required by default, optional for doc modules. **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.
@ -125,6 +135,7 @@ progressively greater amount of knowledge."
### Extra Sections ### Extra Sections
**Status**: Optional. **Status**: Optional.
**Requirements:** **Requirements:**
- None. - None.
@ -135,6 +146,7 @@ progressively greater amount of knowledge."
### API ### API
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Describe exported functions and objects. - Describe exported functions and objects.
@ -146,6 +158,7 @@ progressively greater amount of knowledge."
### Contribute ### Contribute
**Status**: Required. **Status**: Required.
**Requirements:** **Requirements:**
- State where users can ask questions. - State where users can ask questions.
- State whether PRs are accepted. - State whether PRs are accepted.
@ -159,6 +172,7 @@ progressively greater amount of knowledge."
### License ### License
**Status:** Required. **Status:** Required.
**Requirements:** **Requirements:**
- State license initials or name. - State license initials or name.
- State license owner. - State license owner.