Skip to content

Commit

Permalink
Update spec.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoXbresciani authored Mar 1, 2024
1 parent 388aecc commit 5cb862f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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:**
- Be called README (with capitalization) aand have a specific extension depending on its format (`.md` for Markdown, `.org` for Org Mode Markup syntax, `.html` for HTML, ...)
- Be called README (with capitalization) and have a specific extension depending on its format (`.md` for Markdown, `.org` for Org Mode Markup syntax, `.html` for HTML, ...)
- 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 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 file in the selected format (Markdown, Org Mode, HTML, ...).
- Sections must appear in order given below. Optional sections may be omitted.
Expand Down

0 comments on commit 5cb862f

Please sign in to comment.