标签：apache rect 格式 答案 block about 规范 需求 with
A readme (or read me) file contains information about other files in a directory or archive and is very commonly distributed with computer software.
推荐遵守此规则：
Markdown 规范 + GitHub Flavored Markdown
建议叫 README.md
而不是 readme.md 或 README.markdown
尽量替代掉「使用 wiki 或 website 管理文档」（或者 website 是通过 readme 文档生成的，do not repeat yourself）
一个好的 README 需要包含哪些内容？以下是 stackoverflow 给出的答案：
我推荐包含以下内容：
本文转自 https://blog.xcatliu.com/posts/use_readme_to_manage_your_docs.html，如有侵权，请联系删除。
标签：apache rect 格式 答案 block about 规范 需求 with
原文地址：https://www.cnblogs.com/hustshu/p/14877916.html
