README🚙

通用示例项目

这是一个DEMO项目，对项目代码的框架定义。包括README、.gitignore、.editorconfig以及HTML5基础页面等。

上手指南

写几句这样的话概括接下来的内容：以下指南将帮助你在本地机器上安装和运行该项目，进行开发和测试。关于如何将该项目部署到在线环境，请参考部署小节。

安装要求

列出运行该项目必须要具备的条件以及必须要安装的软件，最好给出具体的安装步骤。

1. 必须安装我
2. 我也必须安装
3. 安装我也是必须的

安装步骤

一步一步地说明怎么去搭建环境，怎么让项目跑起来。

首先你需要

1. 干这件事
2. 干那件事
3. 继续干这件事 ......一直到完成。

最后阐述安装完成后的情况，展示下Demo

测试

解释说明一下如何运行该系统的自动测试部分。

分解为端对端测试

解释这些测试是什么以及为什么要做这些测试 1.我是个栗子 2.我也是个栗子 3.我是栗子的哥哥

代码风格测试

解释这些测试是什么以及为什么要做这些测试 1.我是个栗子 2.我也是个栗子 3.我是栗子的哥哥

部署

对以上的安装步骤进行补充说明，描述如何在在线环境中安装该项目。

使用到的框架

Dropwizard - Web框架 Maven - 依赖属性管理 ROME - 生成RSS源

贡献者

请阅读CONTRIBUTING.md 查阅为该项目做出贡献的开发者。

版本控制

该项目使用SemVer进行版本管理。您可以在repository参看当前可用版本。

作者

地球上的盐味 您也可以在贡献者名单中参看所有参与该项目的开发者。

版权说明

该项目签署了MIT 授权许可，详情请参阅 LICENSE.md

鸣谢

该项目参考了XXX的 XXX 灵感来源于XXX 感谢XX的支持和陪伴

链接：

https://github.com/matiassingers/awesome-readme

书写README的各种markdown语法