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

Merge pull request #107 from bugstop/patch-1

Browse Source
This commit is contained in:
Richard Littauer 2020-04-17 08:41:18 -07:00 committed by GitHub
commit e75417ab50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.cn.md
View File

@ -9,7 +9,7 @@ README 文件是人们通常最先看到的第一个东西。它应该告诉人
本仓库包含以下内容： 本仓库包含以下内容：
1. 一个标准的 README 文件应该是什么样子的[规范](spec.md)。 1. 一个标准的 README 文件应该是什么样子的[规范](spec.md)。
2. 一个用于维护 REAME 文件的语法提示工具的链接 ([正在进行中](https://github.com/RichardLitt/standard-readme/issues/5)). 2. 一个用于维护 README 文件的语法提示工具的链接 ([正在进行中](https://github.com/RichardLitt/standard-readme/issues/5))。
3. 一个创建标准 README 的[生成器](https://github.com/RichardLitt/generator-standard-readme)。 3. 一个创建标准 README 的[生成器](https://github.com/RichardLitt/generator-standard-readme)。
4. 一个指向该规范的[徽章](#徽章)。 4. 一个指向该规范的[徽章](#徽章)。
5. [标准 README 的实例](example-readmes/) - 比如你正在读的这个文件。 5. [标准 README 的实例](example-readmes/) - 比如你正在读的这个文件。
@ -19,10 +19,10 @@ README 文件是人们通常最先看到的第一个东西。它应该告诉人
- [背景](#背景) - [背景](#背景)
- [安装](#安装) - [安装](#安装)
- [使用](#使用) - [使用说明](#使用说明)
- [生成器](#生成器) - [生成器](#生成器)
- [徽章](#徽章) - [徽章](#徽章)
- [Readme 示例](#Readme-示例) - [示例](#示例)
- [相关仓库](#相关仓库) - [相关仓库](#相关仓库)
- [维护者](#维护者) - [维护者](#维护者)
- [如何贡献](#如何贡献) - [如何贡献](#如何贡献)
@ -30,13 +30,13 @@ README 文件是人们通常最先看到的第一个东西。它应该告诉人
## 背景 ## 背景
`标准化Readme` 最开始因为 [@maxogden](https://github.com/maxogden) 在项目[feross/standard](https://github.com/feross/standard)的[这个Issue](https://github.com/feross/standard/issues/141)中提出, 是否标准化 README 会有助于帮助大家. 很多人在仓库[zcei's standard-readme](https://github.com/zcei/standard-readme/issues/1) 就这个想法进行了讨论. 在我维护仓库 [IPFS](https://github.com/ipfs)的时候, 我需要在这个组织中推广标准化的 Readme，因此这个项目也就从这开始了. `标准 Readme` 最开始因为 [@maxogden](https://github.com/maxogden) 在项目 [feross/standard](https://github.com/feross/standard) 的[这个 Issue](https://github.com/feross/standard/issues/141) 中提出，是否标准化 README 会有助于帮助大家。很多人在仓库 [zcei's standard-readme](https://github.com/zcei/standard-readme/issues/1) 就这个想法进行了讨论。在我维护仓库 [IPFS](https://github.com/ipfs) 的时候，我需要在这个组织中推广标准化的 Readme，因此这个项目也就从这开始了。
> 如果你的文档是完整的，那么使用你代码的人就不用再去看代码了。这非常的重要。它使得你可以分离接口文档与具体实现。它意味着你可修改实现的代码而保持接口与文档不变。 > 如果你的文档是完整的，那么使用你代码的人就不用再去看代码了。这非常的重要。它使得你可以分离接口文档与具体实现。它意味着你可修改实现的代码而保持接口与文档不变。
> 请记住：是文档而非代码，定义了一个模块的功能。 > 请记住：是文档而非代码，定义了一个模块的功能。
~ [Ken Williams, Perl Hackers](http://mathforum.org/ken/perl_modules.html#document) —— [Ken Williams, Perl Hackers](http://mathforum.org/ken/perl_modules.html#document)
写 README 从某种程度上来说相当不易，一直维护下去更是难能可贵。如果可以减少这个过程，则可以让写代码与修改代码更容易，使得是否在说明中指明一处需改有无必要更加清楚，你可以花费更少的时间来考虑是否你最初的文档是否需要更新，你可以分配更多的时间来写代码而非维护文档。 写 README 从某种程度上来说相当不易，一直维护下去更是难能可贵。如果可以减少这个过程，则可以让写代码与修改代码更容易，使得是否在说明中指明一处需改有无必要更加清楚，你可以花费更少的时间来考虑是否你最初的文档是否需要更新，你可以分配更多的时间来写代码而非维护文档。
@ -44,16 +44,16 @@ README 文件是人们通常最先看到的第一个东西。它应该告诉人
这个仓库的目标是： 这个仓库的目标是：
1. 一个定义良好的**规范**。在仓库中的位置是 [spec.md](spec.md)。它是一个一直在持续优化的文档，欢迎您提 Issue 讨论其中的变化。 1. 一个定义良好的**规范**。在仓库中的位置是 [spec.md](spec.md)。它是一个一直在持续优化的文档，欢迎您提 Issue 讨论其中的变化。
2. 一个**示例 README**。 这个Readme 完全遵从 Standard-readme， 而且在 `example-readmes` 文件夹里有更多的示例. 2. 一个**示例 README**。这个 Readme 完全遵从 Standard-readme，而且在 `example-readmes` 文件夹里有更多的示例。
3. 一个 **语法提示器** 用来提示在Readme 中的语法错误. 请参考 [tracking issue](https://github.com/RichardLitt/standard-readme/issues/5). 3. 一个**语法提示器**用来提示在 Readme 中的语法错误。请参考 [tracking issue](https://github.com/RichardLitt/standard-readme/issues/5)。
4. 一个 **生成器** 用来快速搭建新的 README 的框架。 请参考 [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme). 4. 一个**生成器**用来快速搭建新的 README 的框架。请参考 [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme)。
5. 一个 **标识准守规范的徽章**。 请参考 [徽章](#徽章). 5. 一个**标识准守规范的徽章**。请参考[徽章](#徽章)。
## 安装 ## 安装
这个项目使用 [node](http://nodejs.org) 和 [npm](https://npmjs.com). 请确保你本地安装了它们。 这个项目使用 [node](http://nodejs.org) 和 [npm](https://npmjs.com)。请确保你本地安装了它们。
```sh ```sh
$ npm install --global standard-readme-spec $ npm install --global standard-readme-spec
``` ```
@ -69,8 +69,7 @@ $ standard-readme-spec
### 生成器 ### 生成器
想要使用生成器的话，请看 [generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme)。
想要使用生成器的话, 请看[generator-standard-readme](https://github.com/RichardLitt/generator-standard-readme).
有一个全局的可执行文件来运行包里的生成器，生成器的别名叫 `standard-readme`。 有一个全局的可执行文件来运行包里的生成器，生成器的别名叫 `standard-readme`。
## 徽章 ## 徽章
@ -84,25 +83,25 @@ $ standard-readme-spec
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
``` ```
## Readme 示例 ## 示例
想了解我们建议的规范是如何被应用的，请参考 [example-readmes](example-readmes/)。 想了解我们建议的规范是如何被应用的，请参考 [example-readmes](example-readmes/)。
## 相关仓库 ## 相关仓库
- [Art of Readme](https://github.com/noffle/art-of-readme) - 💌 写高质量 README 的艺术。 - [Art of Readme](https://github.com/noffle/art-of-readme) — 💌 写高质量 README 的艺术。
- [open-source-template](https://github.com/davidbgk/open-source-template/) - 一个鼓励参与开源的 README 模板。 - [open-source-template](https://github.com/davidbgk/open-source-template/) — 一个鼓励参与开源的 README 模板。
## 维护者 ## 维护者
[@RichardLitt](https://github.com/RichardLitt). [@RichardLitt](https://github.com/RichardLitt)。
## 如何贡献 ## 如何贡献
非常欢迎你的加入! [提一个Issue](https://github.com/RichardLitt/standard-readme/issues/new) 或者提交一个 Pull R equest. 非常欢迎你的加入！[提一个 Issue](https://github.com/RichardLitt/standard-readme/issues/new) 或者提交一个 Pull Request。
标准 Readme 遵循 [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) 行为规范. 标准 Readme 遵循 [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) 行为规范。
### 贡献者 ### 贡献者