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

Merge github.com:RichardLitt/standard-readme

Browse Source
This commit is contained in:
Richard Littauer 2017-11-14 19:41:27 -05:00
commit 095aee7683
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -14,6 +14,8 @@ This repository contains:
4. [A badge](#badge) to point to this spec. 4. [A badge](#badge) to point to this spec.
5. [Examples of standard READMEs](example-readmes/) - such as this file you are reading. 5. [Examples of standard READMEs](example-readmes/) - such as this file you are reading.
Standard Readme is designed for open source libraries. Although it’s [historically](#background) made for Node and npm projects, it also applies to libraries in other languages and package managers.
## Table of Contents ## Table of Contents

2
spec.md
View File

@ -2,6 +2,8 @@
A compliant README must satisfy all the requirements listed below. A compliant README must satisfy all the requirements listed below.
> Note: Standard Readme is designed for open source libraries. Although it’s [historically](readme.md#background) made for Node and npm projects, it also applies to libraries in other languages and package managers.
**Requirements:** **Requirements:**
- Be called README.md (with capitalization). - Be called README.md (with capitalization).
- If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. - If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages.