/About-README

开源项目README的介绍及推荐模板

1、README 是什么？

README是介绍和解释项目的文档。包含了解项目需要的通用信息。 是人们了解项目的第一步，告诉用户该如何使用你的代码。同时，标准化的模板能够使得阅读更直观，对集群型项目来说后续维护也更加方便。

模板能适配适大多数项目，然而每个项目各不相同，可以适当看哪部分更匹配。 README 内容应当最大程度的描述详细，不要过于简单。如果 README 内容过多，可考虑更有层次感的表现形式，而不是删减信息。

2、READMETemplate-模板

https://github.com/WeBankFinTech/README-TEMPLATE

3、README FAQ -常见问题

  • 是否有严格的标准格式？

README 中应包含哪些信息，完全由开发人员决定。

  • "README"文件如何命名？

README.md（如果选择使用非标记文件格式，请用其扩展名）。一般用大写，是使它更突出，也可以用小写。

  • 如何进行后续变更？

提交issue或者pr。

本文采用CC BY-SA-NC 4.0

文章中如有任何错误或疏漏，烦请不吝指正。

1. 关于许可证的使用指南
    1. [OSI官方-Licenses & Standards](https://opensource.org/licenses?fileGuid=2wAlXOVLNVUJQjAP)**[https://opensource.org/licenses](https://opensource.org/licenses?fileGuid=2wAlXOVLNVUJQjAP)
    2. [一篇文章讲明白【开源许可证 】 - 知乎 (zhihu.com)](https://zhuanlan.zhihu.com/p/340135415?fileGuid=2wAlXOVLNVUJQjAP)[https://zhuanlan.zhihu.com/p/340135415](https://zhuanlan.zhihu.com/p/340135415?fileGuid=2wAlXOVLNVUJQjAP)
1. 盾牌介绍[Shields.io: Quality metadata badges for open source projects](https://shields.io/?fileGuid=2wAlXOVLNVUJQjAP)
2. issue 社区同步的指引
    1. [How to use osschat · kaiyuanshe/osschat Wiki (github.com)](https://github.com/kaiyuanshe/osschat/wiki/How-to-use-osschat?fileGuid=2wAlXOVLNVUJQjAP)[https://github.com/kaiyuanshe/osschat/wiki/How-to-use-osschat](https://github.com/kaiyuanshe/osschat/wiki/How-to-use-osschat?fileGuid=2wAlXOVLNVUJQjAP)
3. 优秀的项目 README参考
    1. [理查德·利特/标准读物：README 文件的标准样式 (github.com)](https://github.com/RichardLitt/standard-readme?fileGuid=2wAlXOVLNVUJQjAP)**[https://github.com/RichardLitt/standard-readme](https://github.com/RichardLitt/standard-readme?fileGuid=2wAlXOVLNVUJQjAP)
    2. [Apache EventMesh Readme](https://github.com/apache/incubator-eventmesh#readme?fileGuid=2wAlXOVLNVUJQjAP)[https://github.com/apache/incubator-eventmesh#readme](https://github.com/apache/incubator-eventmesh#readme?fileGuid=2wAlXOVLNVUJQjAP)