From c5f938af18eeaf8c2f7c37cc7ea6e068ccbd4c32 Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Wed, 19 Oct 2016 16:36:49 -0400 Subject: [PATCH] Added subtitle option to Top Header Naming See #26 --- spec.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/spec.md b/spec.md index 59bd36f..1e902a8 100644 --- a/spec.md +++ b/spec.md @@ -19,7 +19,13 @@ A compliant README must satisfy all the requirements listed below. **Status:** Required. **Requirements:** -- Title must match repository and package manager names. If any of these don't match, there must be a note in the [Long Description](#long-description) explaining why. +- Title must match repository, folder and package manager names - or it may have another, relevant title with the repository, folder, and package manager title next to it in italics and in parentheses. For instance: + + ```markdown + # Standard Readme Style _(standard-readme)_ + ``` + + If any of the folder, repository, or package manager names do not match, there must be a note in the [Long Description](#long-description) explaining why. **Suggestions:** - Should be self-evident. @@ -62,6 +68,7 @@ A compliant README must satisfy all the requirements listed below. **Requirements:** - Does not require its own title. +- If any of the folder, repository, or package manager names do not match, there must be a note here as to why. See [Title section](#title). **Suggestions:** - If too long, consider moving to the [Background](#background) section.