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 f8d0f8cd756ed87051f63b4fc68caeb498280fb9..a33ea05f731aa27b5acd30cf3eccc6a0d1ecb91e 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 的方式等)。让别人碰到问题时能快速联系到你。