diff --git "a/\347\233\256\345\275\225.md" "b/\347\233\256\345\275\225.md" index 2d87cc6ae392cc833f79e359898c9a243b359db2..923ece39ad7b5676a4e03f8859e0c8ab152ca020 100644 --- "a/\347\233\256\345\275\225.md" +++ "b/\347\233\256\345\275\225.md" @@ -31,13 +31,14 @@ * [开源许可证的应用](第4部分——启动自己的开源项目/开源许可证的应用.md) * [为自己的开源项目建立贡献准则](第4部分——启动自己的开源项目/为自己的开源项目建立贡献准则.md) * [开源项目的维护和管理](第4部分——启动自己的开源项目/开源项目的维护和管理.md) -* [CONTRIBUTING 编写](./第四部分——启动自己的开源项目/CONTRIBUTING 编写.md) +* [CONTRIBUTING 编写](第4部分——启动自己的开源项目/CONTRIBUTING编写.md) ### 第5部分--开源治理 * [个人维护和建立社区,两者如何选择?](第5部分——开源治理/个人维护和建立社区,两者如何选择.md) * [打造开源社区](第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/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" 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 0000000000000000000000000000000000000000..2e492aadb5a1b3dc625bfc7560581323a838293d --- /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 的最开始用 `