参考资料:
https://gist.github.com/PurpleBooth/109311bb0361f32d87a2#project-title
https://github.com/matiassingers/awesome-readme
Project Title 项目标题
One Paragraph of project description goes here
一个描述项目的段落
Getting Started 着手开始
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
这些指导将给给予你一份项目拷贝,用于本地机器的开发或者测试。写下部署项目的建议。
Prerequisites 前期条件
What things you need to install the software and how to install them
哪些基础软件需要安装
Give examples
给出案例列表
Installing 安装
A step by step series of examples that tell you how to get a development env running
一系列样例告诉你如何开发和运行的步骤
Say what the step will be
说出每一步将要做的事
Give the example
And repeat
until finished
直到结束
End with an example of getting some data out of the system or using it for a little demo
以一个案例结束,得到系统或者有用的数据输出
Running the tests 运行测试
Explain how to run the automated tests for this system
检测如何运行系统的自动测试
Break down into end to end tests 细分到端对端测试
Explain what these tests test and why
解释这些测试的目的和意义
Give an example
And coding style tests 代码分格测试
Explain what these tests test and why
解释这些测试的目的和意义
Give an example
Deployment 部署
Add additional notes about how to deploy this on a live system
添加附加的笔记说明如何部署代码到生产环境
Built With 内置组件
- Dropwizard - The web framework used
- Maven - Dependency Management
- ROME - Used to generate RSS Feeds
Contributing 贡献
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
阅读Conteributing.md ,介绍了我们代码生产细节及向我们提交合并请求的过程
Versioning 版本
版本控制规则
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors 作者
- Billie Thompson - Initial work - PurpleBooth
- 姓名 - 工作内容 - 联系方式-博客
See also the list of contributors who participated in this project.
License 许可
This project is licensed under the MIT License - see the LICENSE.md file for details
此项目遵循MIT许可
Acknowledgments 致谢
- Hat tip to anyone whose code was used
- Inspiration
- etc