From 7e2e59fd44dc0d28ca9ab365e39535802f2ceefb Mon Sep 17 00:00:00 2001 From: louislivi <574747417@qq.com> Date: Fri, 11 Dec 2020 15:56:29 +0800 Subject: [PATCH] =?UTF-8?q?update=20=E7=AC=AC=E5=9B=9B=E9=83=A8=E5=88=86?= =?UTF-8?q?=E2=80=94=E2=80=94=E5=90=AF=E5=8A=A8=E8=87=AA=E5=B7=B1=E7=9A=84?= =?UTF-8?q?=E5=BC=80=E6=BA=90=E9=A1=B9=E7=9B=AE/=E4=B8=BA=E5=BC=80?= =?UTF-8?q?=E6=BA=90=E9=A1=B9=E7=9B=AE=E5=BB=BA=E7=AB=8B=E8=89=AF=E5=A5=BD?= =?UTF-8?q?=E7=9A=84=E5=9F=BA=E7=A1=80.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...75\347\232\204\345\237\272\347\241\200.md" | 25 ++++++++++++++++--- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git "a/\347\254\254\345\233\233\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/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" "b/\347\254\254\345\233\233\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/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" index b9d60ad..e45c760 100644 --- "a/\347\254\254\345\233\233\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/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" +++ "b/\347\254\254\345\233\233\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/\344\270\272\345\274\200\346\272\220\351\241\271\347\233\256\345\273\272\347\253\213\350\211\257\345\245\275\347\232\204\345\237\272\347\241\200.md" @@ -27,10 +27,27 @@ 相比还有很多优秀的项目，都有这种让人过目不忘的名称，欢迎继续补充。 -### 如何打造一个优秀的 Readme -``` -补充相关内容 -``` +### 如何打造一个优秀的 README + +README 应该包含哪些内容： + +- 项目名称 +- 项目LOGO：可以设计一张中意的图片，也可以通过[Patorjk](http://patorjk.com/software/taag)生成你想要的字符画。 +- 多语言切换：推荐中英切换链接展现，在项目根目录建立`README.md`以及`README-ZH.md`，若以中文为主则为`README-EN.md`文件。 +- 项目勋章（Badge）：这是一个很好玩的东西并且可以增加项目趣味性，可以通过[Shields](http://img.shields.io)进行生成你想要的 Badge 进行展现。 +- 项目背景：项目背景很简单，就是你为什么做这个项目，动机和背景是什么。 +- 项目特点：项目的核心价值，对比同类型项目的优势以及项目自身的特点是什么。 +- 安装：如何进行项目的安装。 +- 使用：如何使用该项目，这里如果使用方式简单可以直接写进README中如果较为复杂则引入文档链接地址进行指引。 +- 项目参与者：该项目的参与人展现，可以借助[OpenCollective](https://opencollective.com)进行贡献者信息展示。 +- 讨论与反馈：文档以及项目官网指引，项目沟通渠道如QQ群，公众号，项目社区等地址。 +- 项目打赏方式：国内微信，支付宝，还可以使用 Gitee 一键接入打赏，国外常用的有 PayPal,OpenCollective。 +- 参与贡献方式：指引开发者们如何参与到项目中协同完善整个开源项目。 +- 开源协议：开源协议类型指引。 + + +参考成熟的开源项目的README中的内容以及同类型开源项目中的README。 + ### 为项目撰写文档 ``` 补充相关内容 -- Gitee