From a85b36481ffac9708a12f40e7b43c79eb1149bb6 Mon Sep 17 00:00:00 2001 From: afc163 Date: Sat, 4 Nov 2017 11:26:11 +0800 Subject: [PATCH] update README.md --- README.en-US.md | 89 --------------------------------------- README.md | 110 ++++++++++++++++++++++++------------------------ README.zh-CN.md | 89 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 144 insertions(+), 144 deletions(-) delete mode 100644 README.en-US.md create mode 100644 README.zh-CN.md diff --git a/README.en-US.md b/README.en-US.md deleted file mode 100644 index 992095ea..00000000 --- a/README.en-US.md +++ /dev/null @@ -1,89 +0,0 @@ -[简体中文](./README.md) | English - -# Ant Design Pro - -[![](https://img.shields.io/travis/ant-design/ant-design-pro.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Gitter](https://badges.gitter.im/ant-design/ant-design-pro.svg)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - -An out-of-box UI solution for enterprise applications. - -![](https://gw.alipayobjects.com/zos/rmsportal/xEdBqwSzvoSapmnSnYjU.png) - -- Preview: http://preview.pro.ant.design -- Home Page: http://pro.ant.design -- Documentation: http://pro.ant.design/docs/getting-started -- FAQ: http://pro.ant.design/docs/faq - -## Features - -- :gem: **Neat Design**: Follow Ant Design specification -- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications -- :rocket: **State of The Art Development**: Newest development stack of React/dva/antd -- :iphone: **Responsive**: Designed for varies of screen size -- :art: **Themeing**: Customizable theme with simple config -- :globe_with_meridians: **International**: Built-in i18n solution -- :gear: **Best Practice**: Solid workflow make your code health -- :1234: **Mock development**: Easy to use mock development solution -- :white_check_mark: **UI Test**: Fly safely with unit test and e2e test - -## Templates - -``` -- Dashboard - - 分析页 - - 监控页 - - 工作台 -- 表单页 - - 基础表单页 - - 分步表单页 - - 高级表单页 -- 列表页 - - 查询表格 - - 标准列表 - - 卡片列表 - - 搜索列表（项目/应用/文章） -- 详情页 - - 基础详情页 - - 高级详情页 -- 结果 - - 成功页 - - 失败页 -- 异常 - - 403 无权限 - - 404 找不到 - - 500 服务器出错 -- 帐户 - - 登录 - - 注册 - - 注册成功 -``` - -## Usage - -```bash -$ git clone git@github.com:ant-design/ant-design-pro --depth=1 -$ cd ant-design-pro -$ npm install -$ npm start # visit http://localhost:8000 -``` - -Or you can use the command tool: [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli) - -```bash -$ npm install ant-design-pro-cli -g -$ mkdir pro-demo && cd pro-demo -$ pro init -``` - -More instruction at [documentation](http://pro.ant.design/docs/getting-started)。 - -## Compatibility - -Modern browsers and IE11. - -## Contributing - -Any Contribution of following ways will be welcome: - -- Use Ant Design Pro in your daily work. -- Submit [issue](http://github.com/ant-design/ant-design-pro/issues) to report bug or ask questions. -- Propose [pull request](http://github.com/ant-design/ant-design-pro/pulls) to improve our code. diff --git a/README.md b/README.md index bf7ee910..578c2a4f 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,72 @@ -简体中文 | [English](./README.en-US.md) +English | [简体中文](./README.zh-CN.md) # Ant Design Pro -[![](https://img.shields.io/travis/ant-design/ant-design-pro.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Build status](https://ci.appveyor.com/api/projects/status/67fxu2by3ibvqtat/branch/master?svg=true)](https://ci.appveyor.com/project/afc163/ant-design-pro/branch/master) [![Gitter](https://badges.gitter.im/ant-design/ant-design-pro.svg)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) +[![](https://img.shields.io/travis/ant-design/ant-design-pro.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Gitter](https://badges.gitter.im/ant-design/ant-design-pro.svg)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -开箱即用的中台前端/设计解决方案。 +An out-of-box UI solution for enterprise applications. ![](https://gw.alipayobjects.com/zos/rmsportal/xEdBqwSzvoSapmnSnYjU.png) -- 预览：http://preview.pro.ant.design -- 首页：http://pro.ant.design -- 使用文档：http://pro.ant.design/docs/getting-started -- 常见问题：http://pro.ant.design/docs/faq +- Preview: http://preview.pro.ant.design +- Home Page: http://pro.ant.design +- Documentation: http://pro.ant.design/docs/getting-started +- FAQ: http://pro.ant.design/docs/faq -## 特性 +## Features -- :gem: **优雅美观**：基于 Ant Design 体系精心设计 -- :triangular_ruler: **常见设计模式**：提炼自中后台应用的典型页面和场景 -- :rocket: **最新技术栈**：使用 React/dva/antd 等前端前沿技术开发 -- :iphone: **响应式**：针对不同屏幕大小设计 -- :art: **主题**：可配置的主题满足多样化的品牌诉求 -- :globe_with_meridians: **国际化**：内建业界通用的国际化方案 -- :gear: **最佳实践**：良好的工程实践助您持续产出高质量代码 -- :1234: **Mock 数据**：实用的本地数据调试方案 -- :white_check_mark: **UI 测试**：自动化测试保障前端产品质量 +- :gem: **Neat Design**: Follow Ant Design specification +- :triangular_ruler: **Common Templates**: Typical templates for enterprise applications +- :rocket: **State of The Art Development**: Newest development stack of React/dva/antd +- :iphone: **Responsive**: Designed for varies of screen size +- :art: **Themeing**: Customizable theme with simple config +- :globe_with_meridians: **International**: Built-in i18n solution +- :gear: **Best Practice**: Solid workflow make your code health +- :1234: **Mock development**: Easy to use mock development solution +- :white_check_mark: **UI Test**: Fly safely with unit test and e2e test -## 模板 +## Templates ``` - Dashboard - - 分析页 - - 监控页 - - 工作台 -- 表单页 - - 基础表单页 - - 分步表单页 - - 高级表单页 -- 列表页 - - 查询表格 - - 标准列表 - - 卡片列表 - - 搜索列表（项目/应用/文章） -- 详情页 - - 基础详情页 - - 高级详情页 -- 结果 - - 成功页 - - 失败页 -- 异常 - - 403 无权限 - - 404 找不到 - - 500 服务器出错 -- 帐户 - - 登录 - - 注册 - - 注册成功 + - Analytic + - Monitor + - Workspace +- Form + - Basic Form + - Step Form + - Advanced From +- List + - Standard Table + - Standard List + - Card List + - Search List (Project/Applications/Article) +- Profile + - Simple Profile + - Advanced Profile +- Result + - Success + - Failed +- Exception + - 403 + - 404 + - 500 +- User + - Login + - Register + - Register Result ``` -## 使用 +## Usage ```bash $ git clone git@github.com:ant-design/ant-design-pro --depth=1 $ cd ant-design-pro $ npm install -$ npm start # 访问 http://localhost:8000 +$ npm start # visit http://localhost:8000 ``` -也可以使用集成化的 [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli) 工具。 +Or you can use the command tool: [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli) ```bash $ npm install ant-design-pro-cli -g @@ -74,16 +74,16 @@ $ mkdir pro-demo && cd pro-demo $ pro init ``` -更多信息请参考 [使用文档](http://pro.ant.design/docs/getting-started)。 +More instruction at [documentation](http://pro.ant.design/docs/getting-started)。 -## 兼容性 +## Compatibility -现代浏览器及 IE11。 +Modern browsers and IE11. -## 参与贡献 +## Contributing -我们非常欢迎你的贡献，你可以通过以下方式和我们一起共建 :smiley:： +Any Contribution of following ways will be welcome: -- 在你的公司或个人项目中使用 Ant Design Pro。 -- 通过 [Issue](http://github.com/ant-design/ant-design-pro/issues) 报告 bug 或进行咨询。 -- 提交 [Pull Request](http://github.com/ant-design/ant-design-pro/pulls) 改进 Pro 的代码。 +- Use Ant Design Pro in your daily work. +- Submit [issue](http://github.com/ant-design/ant-design-pro/issues) to report bug or ask questions. +- Propose [pull request](http://github.com/ant-design/ant-design-pro/pulls) to improve our code. diff --git a/README.zh-CN.md b/README.zh-CN.md new file mode 100644 index 00000000..6a9e55bd --- /dev/null +++ b/README.zh-CN.md @@ -0,0 +1,89 @@ +[English](./README.md) | 简体中文 + +# Ant Design Pro + +[![](https://img.shields.io/travis/ant-design/ant-design-pro.svg?style=flat-square)](https://travis-ci.org/ant-design/ant-design-pro) [![Build status](https://ci.appveyor.com/api/projects/status/67fxu2by3ibvqtat/branch/master?svg=true)](https://ci.appveyor.com/project/afc163/ant-design-pro/branch/master) [![Gitter](https://badges.gitter.im/ant-design/ant-design-pro.svg)](https://gitter.im/ant-design/ant-design-pro?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +开箱即用的中台前端/设计解决方案。 + +![](https://gw.alipayobjects.com/zos/rmsportal/xEdBqwSzvoSapmnSnYjU.png) + +- 预览：http://preview.pro.ant.design +- 首页：http://pro.ant.design +- 使用文档：http://pro.ant.design/docs/getting-started +- 常见问题：http://pro.ant.design/docs/faq + +## 特性 + +- :gem: **优雅美观**：基于 Ant Design 体系精心设计 +- :triangular_ruler: **常见设计模式**：提炼自中后台应用的典型页面和场景 +- :rocket: **最新技术栈**：使用 React/dva/antd 等前端前沿技术开发 +- :iphone: **响应式**：针对不同屏幕大小设计 +- :art: **主题**：可配置的主题满足多样化的品牌诉求 +- :globe_with_meridians: **国际化**：内建业界通用的国际化方案 +- :gear: **最佳实践**：良好的工程实践助您持续产出高质量代码 +- :1234: **Mock 数据**：实用的本地数据调试方案 +- :white_check_mark: **UI 测试**：自动化测试保障前端产品质量 + +## 模板 + +``` +- Dashboard + - 分析页 + - 监控页 + - 工作台 +- 表单页 + - 基础表单页 + - 分步表单页 + - 高级表单页 +- 列表页 + - 查询表格 + - 标准列表 + - 卡片列表 + - 搜索列表（项目/应用/文章） +- 详情页 + - 基础详情页 + - 高级详情页 +- 结果 + - 成功页 + - 失败页 +- 异常 + - 403 无权限 + - 404 找不到 + - 500 服务器出错 +- 帐户 + - 登录 + - 注册 + - 注册成功 +``` + +## 使用 + +```bash +$ git clone git@github.com:ant-design/ant-design-pro --depth=1 +$ cd ant-design-pro +$ npm install +$ npm start # 访问 http://localhost:8000 +``` + +也可以使用集成化的 [ant-design-pro-cli](https://github.com/ant-design/ant-design-pro-cli) 工具。 + +```bash +$ npm install ant-design-pro-cli -g +$ mkdir pro-demo && cd pro-demo +$ pro init +``` + +更多信息请参考 [使用文档](http://pro.ant.design/docs/getting-started)。 + +## 兼容性 + +现代浏览器及 IE11。 + +## 参与贡献 + +我们非常欢迎你的贡献，你可以通过以下方式和我们一起共建 :smiley:： + +- 在你的公司或个人项目中使用 Ant Design Pro。 +- 通过 [Issue](http://github.com/ant-design/ant-design-pro/issues) 报告 bug 或进行咨询。 +- 提交 [Pull Request](http://github.com/ant-design/ant-design-pro/pulls) 改进 Pro 的代码。 -- GitLab