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

Moved Table of Contents

Browse Source
This commit is contained in:
Richard Littauer 2016-05-13 12:31:22 -04:00
parent 3d0b88a8f3
commit fc941187bf
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -12,7 +12,7 @@ This repo is for standardizing how READMEs should look. The goal is to have:
- A linter that can be used to look at errors in a given Readme; - A linter that can be used to look at errors in a given Readme;
- A generator that can be used to quickly scaffold out new READMEs. - A generator that can be used to quickly scaffold out new READMEs.
** Table of Contents ** ## Table of Contents**
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
@ -122,8 +122,7 @@ A compliant README must:
**Status:** Required. **Status:** Required.
**Requirements:** **Requirements:**
- Must link to all Markdown sections in the file. - Must link to all Markdown sections in the file.
- Must not have a Markdown header, `####`, but must be in bold, on it's own line. - Must start with the next section; do not include the title or Table of Contents headings.
- Must start with the next section; do not include the title.
#### Security #### Security
**Status**: Optional. **Status**: Optional.