1 项目做什么 |
---|
简单介绍一下该项目的内容。它应该像一个小的摘要格式,告知项目的主要目的。 |
2 项目为什么有用 |
---|
许可证的简短描述。(麻省理工学院、阿帕奇等) |
3 用户如何使用项目 |
---|
许可证的简短描述。(麻省理工学院、阿帕奇等) |
4 用户能从何处获取项目的帮助 |
---|
许可证的简短描述。(麻省理工学院、阿帕奇等) |
5 谁维护和参与项目/制作人员 |
---|
给予适当的信用是最重要的。提及任何帮助您或启发您构建此项目的链接/存储库。它可以是一个博客、另一个开源项目,或者只是为构建该项目做出贡献的人。 |
参考资料
- GITHUB - About README.md
- GREAT LEARNING - What is Readme?