README

即将推出。

是什么

这是什么，它的用途是什么？请用有意义、简短、平实的语言描述这个项目试图实现的目标以及为什么它很重要。描述这个项目解决的问题。

完成了吗？这是一个原型吗？它是一个僵尸吗？Alpha、Beta、1.1 等。也可以写一句话。目标是让感兴趣的人了解这个项目所处的位置。这也是链接到变更日志的好地方。

链接到其他谈论你的工作的人。

更详细地解释为什么这个项目存在。告诉我们所有关于它的事情。

你是谁？你的合作伙伴是谁？链接、标志和大量的认可。

在我们开始你的项目之前，我们需要知道什么。描述任何必须安装以使该软件正常工作的依赖关系。这包括编程语言、数据库或其他存储机制、构建工具、框架等。如果需要其他软件的特定版本，或已知无法工作，请指出。链接到其他如何做将有所帮助。

如何安装、配置和运行项目的详细说明。这应该经常进行测试以确保可靠性。

非常清晰的说明，包括

逐行命令

可复制和粘贴

参见 CfAPI 中的示例。

更多必需的命令和教程链接。

如果该软件包括自动化测试，请详细说明如何运行这些测试。

如何让其他人贡献的简要说明。确保展示如何提交问题和拉取请求。包括一个 CONTRIBUTING.md 文件。这里是一个很好的 CfA 示例。GitHub也有一些关于如何贡献的新指南。

指向 Code for America 版权和 LICENSE.md 文件的链接。