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

Added subtitle option to Top Header Naming

Browse Source 
See #26
This commit is contained in:
Richard Littauer 2016-10-19 16:36:49 -04:00
parent f613fd1afb
commit c5f938af18
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spec.md
View File

@ -19,7 +19,13 @@ A compliant README must satisfy all the requirements listed below.
**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, folder and package manager names - or it may have another, relevant title with the repository, folder, and package manager title next to it in italics and in parentheses. For instance:
```markdown
# Standard Readme Style _(standard-readme)_
```
If any of the folder, repository, or package manager names do not match, there must be a note in the [Long Description](#long-description) explaining why.
**Suggestions:** **Suggestions:**
- Should be self-evident. - Should be self-evident.
@ -62,6 +68,7 @@ A compliant README must satisfy all the requirements listed below.
**Requirements:** **Requirements:**
- Does not require its own title. - Does not require its own title.
- If any of the folder, repository, or package manager names do not match, there must be a note here as to why. See [Title section](#title).
**Suggestions:** **Suggestions:**
- If too long, consider moving to the [Background](#background) section. - If too long, consider moving to the [Background](#background) section.