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

Update spec.md

Browse Source 
Redundant information about document-based modules has been removed from the Install and Usage sections - it is already stated in their Status subsections.
This commit is contained in:
Dominik Salvet 2019-06-07 19:20:13 +02:00 committed by GitHub
parent 7180c59c16
commit 1c06b0016c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spec.md
View File

@ -144,7 +144,6 @@ progressively greater amount of knowledge."
**Suggestions:**
- Link to prerequisite sites for programming language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc.
- Include any system-specific information needed for installation.
- If there is no code in the module - for instance, a document-based module - this section is not required.
- An `Updating` section would be useful for most packages, if there are multiple versions which the user may interface with.
### Usage
@ -161,7 +160,6 @@ progressively greater amount of knowledge."
**Suggestions:**
- Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here.
- If relevant, point to a runnable file for the usage code.
- If there is no code in the module - for instance, a document-based module - this section is not required.
### Extra Sections
**Status**: Optional.