README

是什么

这是什么以及它的用途？请提供一个有意义、简短、通俗易懂的项目描述，说明这个项目试图解决的问题及其重要性。描述此项目解决的问题。

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

链接到其他人讨论您的工作。

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

你是谁？你的合作伙伴是谁？链接、标志和大量的信用给予。

在我们开始您的项目之前，告诉我们需要了解的内容。描述必须安装的任何依赖项，以便此软件运行。这包括编程语言、数据库或其他存储机制、构建工具、框架等。如果需要特定版本的软件，或者已知无法工作，请指出。链接到其他如何操作将有所帮助。

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

非常清晰的说明，包括

逐行命令

可复制粘贴

查看CfAPI的示例。

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

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

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

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