From f92456b01f24016b334489a385b5430fa6e0b0f7 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Wed, 27 Jul 2016 17:22:47 -0400 Subject: [PATCH 1/2] Make install and usage optional for doc repos See https://github.com/RichardLitt/standard-readme/issues/21 --- spec.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/spec.md b/spec.md index 28d7c52..16e7273 100644 --- a/spec.md +++ b/spec.md @@ -99,9 +99,10 @@ Subsections: - `Updating`. Optional. **Suggestions:** -- Link to prerequisite sites for language. [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc. +- Link to prerequisite sites for language: [npmjs](https://npmjs.com), [godocs](https://godoc.org), etc. - Include any system-specific information needed for Installation. -- Subsection for dependencies needed for install to work. +- Subsection for dependencies needed for install to work. +- If there is no code in the module - for instance, a document-based module - this section is not required. #### Usage **Status:** Required. @@ -116,6 +117,7 @@ Subsections: **Suggestions:** - Cover basic choices that may affect usage: for instance, if JavaScript, cover promises/callbacks, ES6 here. +- If there is no code in the module - for instance, a document-based module - this section is not required. #### Extra Sections **Status**: Optional. From c555f1f5d281f36c86c38fea39433e35ab9e88df Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Thu, 28 Jul 2016 13:55:41 -0400 Subject: [PATCH 2/2] Added optionality to required things --- spec.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec.md b/spec.md index 16e7273..ec0f573 100644 --- a/spec.md +++ b/spec.md @@ -68,7 +68,7 @@ progressively greater amount of knowledge." #### Table of Contents -**Status:** Required. +**Status:** Required by default, optional for READMEs less than 100 lines. **Requirements:** - Must link to all Markdown sections in the file. - Must start with the next section; do not include the title or Table of Contents headings. @@ -90,7 +90,7 @@ progressively greater amount of knowledge." - Cover intellecutal provenance: A `See Also` section is also fitting. #### Install -**Status:** Required. +**Status:** Required by default, optional for doc modules. **Requirements:** - Code block illustrating how to install. @@ -105,7 +105,7 @@ Subsections: - If there is no code in the module - for instance, a document-based module - this section is not required. #### Usage -**Status:** Required. +**Status:** Required by default, optional for doc modules. **Requirements:** - Code block illustrating common usage. - If CLI compatible, code block indicating common usage.