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

feat: add definitions section

Browse Source
This commit is contained in:
Richard Littauer 2017-11-14 14:47:02 -05:00
parent 468156d2b4
commit 13063840cb
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spec.md
View File

@ -34,6 +34,7 @@ _Note: This is only a navigation guide for the specification, and does not defin
- [API](#api) - [API](#api)
- [Contribute](#contribute) - [Contribute](#contribute)
- [License](#license) - [License](#license)
- [Definitions](#definitions)
## Sections ## Sections
@ -133,7 +134,7 @@ progressively greater amount of knowledge."
- Cover intellectual provenance: A `See Also` section is also fitting. - Cover intellectual provenance: A `See Also` section is also fitting.
### Install ### Install
**Status:** Required by default, optional for doc modules. **Status:** Required by default, optional for [documentation repositories](#definitions).
**Requirements:** **Requirements:**
- Code block illustrating how to install. - Code block illustrating how to install.
@ -148,7 +149,7 @@ progressively greater amount of knowledge."
- If there is no code in the module - for instance, a document-based module - this section is not required. - If there is no code in the module - for instance, a document-based module - this section is not required.
### Usage ### Usage
**Status:** Required by default, optional for doc modules. **Status:** Required by default, optional for [documentation repositories](#definitions).
**Requirements:** **Requirements:**
- Code block illustrating common usage. - Code block illustrating common usage.
@ -222,3 +223,9 @@ progressively greater amount of knowledge."
**Suggestions:** **Suggestions:**
- Link to longer License file in local repository. - Link to longer License file in local repository.
## Definitions
_These definitions are provided to clarify any terms used above._
- **Documentation repositories**: Repositories without any functional code. For instance, [RichardLitt/knowledge](https://github.com/RichardLitt/knowledge).