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

Merge github.com:RichardLitt/standard-readme

Browse Source
This commit is contained in:
Richard Littauer 2017-11-14 15:25:37 -05:00
commit 9e11fce881
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
spec.md
View File

@ -30,6 +30,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
@ -129,7 +130,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.
@ -144,7 +145,7 @@ progressively greater amount of knowledge."
- An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with. - An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with.
### 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.
@ -212,9 +213,15 @@ progressively greater amount of knowledge."
**Status:** Required. **Status:** Required.
**Requirements:** **Requirements:**
- State license initials or name. - State license full name or identifier, as listed on the [SPDX](https://spdx.org/licenses/) license list. For unlicensed repositories, add `UNLICENSED`. For more details, add `SEE LICENSE IN <filename>` and link to the license file. (These requirements were adapted from [npm](https://docs.npmjs.com/files/package.json#license)).
- State license owner. - State license owner.
- Must be last section. - Must be last section.
**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).