From 09ae73c6f5e1cb9637dea204e0386cfa96421d5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=98=BF=E5=9F=BA=E7=B1=B3=E4=B8=9C?= <870179822@qq.com> Date: Mon, 16 Nov 2020 20:07:37 +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/=E6=9C=89=E4=BA=86?= =?UTF-8?q?=E5=BC=80=E6=BA=90=E7=9A=84=E6=83=B3=E6=B3=95=E5=90=8E=E4=BB=8E?= =?UTF-8?q?=E4=BD=95=E5=BC=80=E5=A7=8B.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...20\216\344\273\216\344\275\225\345\274\200\345\247\213.md" | 4 ++-- 1 file changed, 2 insertions(+), 2 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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.md" index f8d0f8c..a33ea05 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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.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/\346\234\211\344\272\206\345\274\200\346\272\220\347\232\204\346\203\263\346\263\225\345\220\216\344\273\216\344\275\225\345\274\200\345\247\213.md" @@ -97,7 +97,7 @@ 一个好的 Readme 应该包含以下几点： -1）项目的名称，简短介绍，基本上简短概括为主，说明你的项目主要用在哪些领域，能解决哪些问题。 +1）项目的名称和简介，基本上简短概括为主，说明你的项目主要用在哪些领域，能解决哪些问题。 2）项目的特性，也是以简洁的语言进行概括几点。 @@ -105,7 +105,7 @@ 4）个人不太建议把项目的文档写在 readme 中，因为文档本身是项目使用的详细说明，会涵盖各个方面，放到 readme 里面不太妥当，如果你有自己的文档页面，应当在 readme 里面放一个超链进行跳转。当然如果你的项目非常的小，基本上一页纸就能说完的事情，放到 readme 中也是可以的。 -5）作者的介绍，和联系方式（或者提供提 Issue 或者 Pull Requests 的方式等）。让别人碰到问题时能快速联系到你。 +5）作者的介绍和联系方式（或者提供提 Issue 或者 Pull Requests 的方式等）。让别人碰到问题时能快速联系到你。 -- Gitee