README.sample-CN.md

项目名称

Additional information or tag line

简要描述项目的用途。

安装 / 使用

简要介绍运行一个Hello World需要的最简单步骤。

commands here  // 在这里写命令

在这里说明代码的执行结果。

开发

构建

列出使用的主要库和框架(如React, Angular)，包括版本号。

依赖

开发环境需要安装的。比如全局依赖或其他工具，最好提供下载链接。

Setting up Dev

下面简要介绍一下开发者运行项目必须要做的事情。

git clone https://github.com/your/your-project.git  // 克隆项目
cd your-project/  // 进入目录
packagemanager install  // 安装环境

紧接着逐步说明会发生的事情。在需要虚拟环境、本地服务器或者数据库的时候，也要特此说明。

构建

修改代码后，需要进行其他操作的时候，请在此说明。例如：

./configure  // 生成配置文件
make  // 编译
make install  // 安装

在这说明代码执行后发生的事情。

部署 / 发布

指导开发者如何构建和发布新版应用。在发布的过程中，如果有一些必须要做的步骤，请在此声明。

packagemanager deploy your-project -s server.com -u username -p password

And again you'd need to tell what the previous code actually does.

版本

我们可以使用SemVer（语义化版本规范）进行版本管理。当前项目的版本，请见当前仓库的tags（当前项目没有Tag）。

配置

在这里写下所有用户可以使用的配置。

测试

用例子来说明如何进行测试。解释代码测试了什么，以及为什么要进行测试。

Give an example

Style guide

介绍你的代码风格，并演示如何检验是否符合规范。

Api Reference

描述所有接口需要的参数（包括认证方法）。如果在站外有API文档，请给出文档链接。

数据库

说明项目使用的数据库，给出下载链接。另外写出数据库的设计、模式、关系等。

许可证

声明你正在使用的许可证以及查找全文的方法。