开源项目准则
自述文件
在自述文件中，尝试回答以下问题：
-
What does this project do? 这个项目是做什么的？
-
Why is this project useful? 为什么这个项目有用？
-
How do I get started? 如何开始？
-
Where can I get more help, if I need it? 如果需要，我可以在哪里获得更多帮助？
更好的文档意味着更多的用户、更少的支持请求和更多的贡献者。(...)请记住，你的读者不是你。有些人可能会有一个完全不同的经历
您可以使用自述文件回答其他问题，例如如何处理贡献、项目目标是什么以及有关许可和归属的信息。
如果您不想接受贡献，或者您的项目尚未准备好投入生产，请写下此信息。