- [英文](./README_EN.md)
- [中文](./README.md)
  
## 项目启动

* 安装依赖：在项目跟目录下执行命令 `yarn`
* 编译模块：在项目根目录下执行命令 `yarn build`，生成 `lib`文件夹

## Demo 启动
* 第一步：下载 xrngo app 到手机上
* 第二部：进入 `/example`目录，执行命令 `yarn`
  * 执行命令 `yarn start`
  * 手机打开 xrngo 

## 单元测试

* 运行单测：在项目根目录执行命令 `yarn test`

## 本地文档
* 运行文档：在项目根目录执行命令 `yarn doc`
* 构建文档：在项目根目录执行命令 `yarn doc:build`