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

Added suggestions for see also, runnable examples

Browse Source 
Closed #3
This commit is contained in:
Richard Littauer 2016-05-13 12:28:41 -04:00
parent 962c15197d
commit 9d38e0f52c
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -135,7 +135,7 @@ A compliant README must:
**Requirements:** **Requirements:**
- Cover motivation. - Cover motivation.
- Cover abstract dependencies. - Cover abstract dependencies.
- Cover intellecutal provenance. - Cover intellecutal provenance: A `See Also` section is also fitting.
#### Installation #### Installation
**Status:** Required. **Status:** Required.
@ -160,6 +160,7 @@ Subsections:
Subsections: Subsections:
- `CLI`. Required if CLI functionality exists. - `CLI`. Required if CLI functionality exists.
- If relevant, point to a runnable file for the usage code.
**Suggestions:** **Suggestions:**
- Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here. - Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here.
@ -172,11 +173,11 @@ Subsections:
#### API #### API
**Status:** Optional. **Status:** Optional.
**Requirements:** **Requirements:**
- Describe exported functions and objects. - Describe exported functions and objects.
**Suggestions:** **Suggestions:**
- Describe signatures, return types, callbacks, and events. - Describe signatures, return types, callbacks, and events.
- Cover types covered where not obvious. - Cover types covered where not obvious.
- Describe caveats. - Describe caveats.
#### Contribute #### Contribute