diff --git a/spec.md b/spec.md index 8b5c2cc..5311418 100644 --- a/spec.md +++ b/spec.md @@ -2,11 +2,11 @@ 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. +> 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:** - 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 there is only one README and the language is not English, than a different language in the text is permissible without needing to to specify the BCP tag: e.g., `README.md` can be in German if there is no `README.md` in another language. Where there are multiple languages, `README.md` is reserved for English. + - 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 there is only one README and the language is not English, then a different language in the text is permissible without needing to to specify the BCP tag: e.g., `README.md` can be in German if there is no `README.md` in another language. Where there are multiple languages, `README.md` is reserved for English. - Be a valid Markdown file. - Sections must appear in order given below. Optional sections may be omitted. - Sections must have the titles listed below, unless otherwise specified. If the README is in another language, the titles must be translated into that language.