From b40e20e3239e0587568d610d92f99c85dfd4d85d Mon Sep 17 00:00:00 2001 From: csp <1165680007@qq.com> Date: Fri, 6 May 2022 15:59:08 +0800 Subject: [PATCH] =?UTF-8?q?onepiece=E7=A4=BE=E5=8C=BA=E5=90=8E=E5=8F=B0?= =?UTF-8?q?=E6=A8=A1=E5=9D=97=E5=88=9D=E5=A7=8B=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.en.md | 36 --------------------------- README.md | 70 +++++++++++++++++++++++++++++++++------------------- 2 files changed, 45 insertions(+), 61 deletions(-) delete mode 100644 README.en.md diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 4fd2c4c..0000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# onepiece-admin - -#### Description -onepiece-admin - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index 41886f1..4c89a72 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,57 @@ -# onepiece-admin +# Ant Design Pro -#### 介绍 -onepiece-admin +This project is initialized with [Ant Design Pro](https://pro.ant.design). Follow is the quick guide for how to use. -#### 软件架构 -软件架构说明 +## Environment Prepare +Install `node_modules`: -#### 安装教程 +```bash +npm install +``` -1. xxxx -2. xxxx -3. xxxx +or -#### 使用说明 +```bash +yarn +``` -1. xxxx -2. xxxx -3. xxxx +## Provided Scripts -#### 参与贡献 +Ant Design Pro provides some useful script to help you quick start and build with web project, code style check and test. -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +Scripts provided in `package.json`. It's safe to modify or add additional script: +### Start project -#### 特技 +```bash +npm start +``` -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +### Build project + +```bash +npm run build +``` + +### Check code style + +```bash +npm run lint +``` + +You can also use script to auto fix some lint error: + +```bash +npm run lint:fix +``` + +### Test code + +```bash +npm test +``` + +## More + +You can view full document on our [official website](https://pro.ant.design). And welcome any feedback in our [github](https://github.com/ant-design/ant-design-pro).