fz-mirrors/GitGuide
1
0
Fork 0
mirror of https://github.com/ZJDoc/GitGuide.git synced 2026-07-24 21:00:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add

Browse Source
This commit is contained in:
zjkjzj
2021-03-18 15:07:35 +08:00
parent 8bc5d96ed6
commit e2dc79393a
16 changed files with 1004 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/readme/index.md Normal file
View File

@@ -0,0 +1,10 @@
# 如何写好README
`README`常常是工程的第一个入口，经常不知道写些什么，如何介绍工程的内容。在网上找了资料，发现这是很多人遇到的问题，也有很多热心人士发表了自己的意见
主要参考[RichardLitt/standard-readme](https://github.com/RichardLitt/standard-readme)，里面提出了一整套`REAMDE`规范，包括编写规范、`linter`、生成器、徽章以及示例
另外[kylelobo/The-Documentation-Compendium](https://github.com/kylelobo/The-Documentation-Compendium#templates)和[如何写好Github中的readme？](https://www.zhihu.com/question/29100816)也给出了很多建议
最终实现：[如何编写好的README](https://blog.zhujian.life/posts/79f69ebe.html)