From 6cc9df798c5a03c93d1e7c529782f576e0164a0e Mon Sep 17 00:00:00 2001
From: huifer <huifer97@163.com>
Date: Sat, 12 Dec 2020 14:04:15 +0800
Subject: [PATCH 1/2] =?UTF-8?q?fix:=20=E6=96=87=E4=BB=B6=E5=90=8D=E7=A7=B0?=
 =?UTF-8?q?=E4=BF=AE=E6=94=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 "\347\233\256\345\275\225.md"                                   | 2 +-
 .../CONTRIBUTING\347\274\226\345\206\231.md"                    | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename "\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING \347\274\226\345\206\231.md" => "\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING\347\274\226\345\206\231.md" (100%)

diff --git "a/\347\233\256\345\275\225.md" "b/\347\233\256\345\275\225.md"
index 2d87cc6..431ee0f 100644
--- "a/\347\233\256\345\275\225.md"
+++ "b/\347\233\256\345\275\225.md"
@@ -31,7 +31,7 @@
 * [开源许可证的应用](第4部分——启动自己的开源项目/开源许可证的应用.md)  
 * [为自己的开源项目建立贡献准则](第4部分——启动自己的开源项目/为自己的开源项目建立贡献准则.md)  
 * [开源项目的维护和管理](第4部分——启动自己的开源项目/开源项目的维护和管理.md)  
-* [CONTRIBUTING 编写](./第四部分——启动自己的开源项目/CONTRIBUTING 编写.md)
+* [CONTRIBUTING 编写](第4部分——启动自己的开源项目/CONTRIBUTING编写.md)
 
 ### 第5部分--开源治理
 * [个人维护和建立社区，两者如何选择？](第5部分——开源治理/个人维护和建立社区，两者如何选择.md)  
diff --git "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING \347\274\226\345\206\231.md" "b/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING\347\274\226\345\206\231.md"
similarity index 100%
rename from "\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING \347\274\226\345\206\231.md"
rename to "\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/CONTRIBUTING\347\274\226\345\206\231.md"
-- 
Gitee


From a9760c9fb6cf4d8e880d8cd5ca08deea8707acc2 Mon Sep 17 00:00:00 2001
From: huifer <huifer97@163.com>
Date: Sat, 12 Dec 2020 14:05:31 +0800
Subject: [PATCH 2/2] =?UTF-8?q?docs:=20readme=20=E7=BC=96=E5=86=99?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 "\347\233\256\345\275\225.md"                 |   1 +
 .../Readme\347\274\226\345\206\231.md"        | 164 ++++++++++++++++++
 2 files changed, 165 insertions(+)
 create mode 100644 "\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/Readme\347\274\226\345\206\231.md"

diff --git "a/\347\233\256\345\275\225.md" "b/\347\233\256\345\275\225.md"
index 431ee0f..923ece3 100644
--- "a/\347\233\256\345\275\225.md"
+++ "b/\347\233\256\345\275\225.md"
@@ -38,6 +38,7 @@
 * [打造开源社区](第5部分——开源治理/打造开源社区.md)  
 * [开源项目的常见治理架构](第5部分——开源治理/开源项目的常见治理架构.md)  
 * [确保开源代码质量的几个要点](第5部分——开源治理/确保开源代码质量的几个要点.md) 
+* [Readme编写](第4部分——启动自己的开源项目/Readme编写.md)
 
 ### 第6部分--其他问题
 * [怎样在本职工作和开源项目间做好平衡](第6部分——其他问题/怎样在本职工作和开源项目间做好平衡.md)
diff --git "a/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/Readme\347\274\226\345\206\231.md" "b/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/Readme\347\274\226\345\206\231.md"
new file mode 100644
index 0000000..2e492aa
--- /dev/null
+++ "b/\347\254\2544\351\203\250\345\210\206\342\200\224\342\200\224\345\220\257\345\212\250\350\207\252\345\267\261\347\232\204\345\274\200\346\272\220\351\241\271\347\233\256/Readme\347\274\226\345\206\231.md"
@@ -0,0 +1,164 @@
+# 如何编写 Readme
+
+本文将介绍关于 readme 文档的编写. 主要从 readme 应该包含的几方面展开
+
+
+
+
+
+## 项目名称
+
+- 首先是项目名称, 给项目取一个名字在正常不过了. 一般我们会在 readme 的最开始用 `<h1>项目名称</h1>` 这样的方式来展示项目名称. 项目名称是在整个 readme 中最大的一个标题.
+
+
+
+
+
+
+
+## 项目介绍
+
+- 项目介绍一般会跟着项目名称下面, 着重介绍项目解决的问题、项目提供的功能等.
+
+
+
+## 徽章
+
+- 在 readme 中可以通过一些徽章来给其填上一点颜色
+- 这些会在一般在 项目名称下面
+- 徽章制作网站: http://shields.io/
+
+
+
+
+
+## 使用
+
+- 使用部分区分于项目名称和项目介绍, 它是一段新的标题. 采用比项目名称小一号的标题`<h2>使用</h2>`
+
+- 使用这里会有一些差异化, 有一些喜欢使用 `Usage` 作为标题, 也有选择用 `Example` 作为标题. 笔者看来这两者都可以, 它们都会将项目的使用告诉项目的使用者. 不过光看 readme 中的使用是不够的, 项目作者还需要提供更多的使用案例, 可以是测试用例, 使用文档等, 这些内容通过 wiki 或者 markdown 等形式进行编写后在使用中提供一个跳转地址进行阅读
+
+
+
+
+
+## 安装
+
+- 安装和使用一样都采用比项目名称小一号的标题`<h2>安装</h2>`
+
+- 安装的英文比较统一  `Install`
+
+- 在安装中会根据不同语言来编写具体的安装方式，下面举几个例子
+
+  如 npm 管理的情况下可以直接用 `npm install package_name`
+
+  maven 管理的情况下可以直接贴出 maven 坐标地址
+
+
+
+
+
+## 获取帮助
+
+- 获取帮助部分会写下当使用者遇到问题后如何向项目负责人、负责团队寻求帮助.
+
+- 获取帮助的英文:
+
+
+
+
+
+## 从源码构建
+
+- 从源码构建部分会介绍当获取到当前项目的源代码后如何将其编译的过程.
+- 从源码构建的英文: `Building from Source`
+
+
+
+
+
+
+
+## 报告问题
+
+- 报告问题部分会介绍当使用者发现问题了后应该如何将问题告诉项目负责人、项目负责团队
+- 报告问题的英文: `Reporting Issues`
+
+
+
+
+
+## 行为准则
+
+- 行为准则一般会是一个文件, 会专门编写, 在 readme 中使用跳转的形式进行阅读
+- 行为准则的英文: `Code of Conduct`
+
+
+
+## 文献资料
+
+- 文献资料一般是大量文件, 这些文件都是对当前项目的文档补充.
+- 文献资料的英文: `Documentation`
+
+
+
+## 贡献
+
+- 贡献中会写出贡献代码或者其他内容的方式, 一般也会有一个单独的文件进行详细说明.
+- 贡献的英文: `Contributing`
+
+
+
+
+
+## 功能列表
+
+- 功能列表部分会列出当前项目中的部分也可能是所有的功能
+- 功能列表的英文: `Features`
+
+
+
+
+
+## 变更日志
+
+- 变更过日志是一个文件, 在其中会有整个项目的变更记录.
+- 变更日志的英文: `Changelog`
+
+
+
+## 作者
+
+- 作者部分会将参与本项目的人都会在这里编写
+- 作者的英文: `Contributors`
+
+
+
+
+
+## 许可证
+
+- 许可证部分会贴出当前项目所使用的许可证, 以及许可证连接地址
+
+- 许可证的英文: `License`
+
+
+
+
+
+
+
+
+
+- 在了解了 readme 中有那些内容后就可以着手编辑了. 各位可以使用文中提到的英文作为标题，也可以使用中文, 如果需要国际化可以采用 `readne_语言标记.md`的形式来作为文件名称, 为了突出 readme 可以将这些 `readme_` 文件都大写标 `README_` 
+
+
+
+
+
+
+
+
+
+
+
-- 
Gitee