Skip to content

Commit 616df9e

Browse files
docs: update README files to specify the project as Ant Design Vue Pro for Vue 2 and add a link for the Vue 3 version
1 parent 5bdbbea commit 616df9e

File tree

2 files changed

+40
-35
lines changed

2 files changed

+40
-35
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
English | [简体中文](./README.zh-CN.md)
22

3-
<h1 align="center">Ant Design Vue Pro</h1>
3+
<h1 align="center">Ant Design Vue Pro for Vue 2</h1>
44
<div align="center">
55
An out-of-box UI solution for enterprise applications as a Vue boilerplate. based on <a href="https://vuecomponent.github.io/ant-design-vue/docs/vue/introduce-cn/" target="_blank">Ant Design of Vue</a>
66
</div>
77

8+
<div align="center">
9+
If you are looking for the Vue 3 version, please visit [Ant Design Vue Pro for Vue 3](https://store.antdv.com/items/admin-pro)
10+
</div>
11+
812
<div align="center">
913

1014
[![License](https://img.shields.io/npm/l/package.json.svg?style=flat)](https://github.com/vueComponent/ant-design-vue-pro/blob/master/LICENSE)
@@ -21,8 +25,7 @@ An out-of-box UI solution for enterprise applications as a Vue boilerplate. base
2125
- FAQ: https://pro.antdv.com/docs/faq
2226
- Vue3 ProLayout: https://github.com/vueComponent/pro-layout
2327

24-
Overview
25-
----
28+
## Overview
2629

2730
![dashboard](https://static-2.loacg.com/open/static/github/SP1.png)
2831

@@ -33,54 +36,57 @@ Overview
3336
- webpack
3437
- eslint
3538
- @vue/cli
36-
- [[email protected]](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue
39+
- [[email protected]](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue
3740
- [vue-cropper](https://github.com/xyxiao001/vue-cropper) - Picture edit
3841
- [@antv/g2](https://antv.alipay.com/zh-cn/index.html) - AntV G2
39-
- [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation) - Antv/G2 of Vue
40-
41-
> Note: [Yarn](https://yarnpkg.com/) package management is recommended, the exact same version loaded with the demo site of this project (yarn.lock) . but you can also use npm
42+
- [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation) - Antv/G2 of Vue
4243

44+
> Note: [Yarn](https://yarnpkg.com/) package management is recommended, the exact same version loaded with the demo site of this project (yarn.lock) . but you can also use npm
4345
4446
### Project setup
4547

4648
- Clone repo
49+
4750
```bash
4851
git clone https://github.com/vueComponent/ant-design-vue-pro.git
4952
cd ant-design-vue-pro
5053
```
5154

5255
- Install dependencies
56+
5357
```
5458
yarn install
5559
```
5660

5761
- Compiles and hot-reloads for development
62+
5863
```
5964
yarn run serve
6065
```
6166

6267
- Compiles and minifies for production
68+
6369
```
6470
yarn run build
6571
```
6672

6773
- Lints and fixes files
74+
6875
```
6976
yarn run lint
7077
```
7178

72-
7379
### Other
7480

7581
- **IMPORTANT : Issue feedback !! when opening Issue read [Issue / PR Contributing](https://github.com/vueComponent/ant-design-vue-pro/issues/90)**
7682

7783
- [Vue-cli3](https://cli.vuejs.org/guide/) used by the project.
7884

79-
- Disable Eslint (not recommended): remove `eslintConfig` field in `package.json` and `vue.config.js` field `lintOnSave: false`
85+
- Disable Eslint (not recommended): remove `eslintConfig` field in `package.json` and `vue.config.js` field `lintOnSave: false`
8086

8187
- Load on Demand `/src/main.js` L14, in `import './core/lazy_use'`, `import './core/use''`. more [load-on-demand.md](./docs/load-on-demand.md)
8288

83-
- Customize Theme: [Custom Theme Config (@kokoroli)](https://github.com/kokoroli/antd-awesome/blob/master/docs/Ant_Design_%E6%A0%B7%E5%BC%8F%E8%A6%86%E7%9B%96.md)
89+
- Customize Theme: [Custom Theme Config (@kokoroli)](https://github.com/kokoroli/antd-awesome/blob/master/docs/Ant_Design_%E6%A0%B7%E5%BC%8F%E8%A6%86%E7%9B%96.md)
8490

8591
- I18n: [locales (@musnow)](./src/locales/index.js)
8692

@@ -93,11 +99,10 @@ yarn run lint
9399
Modern browsers and IE10.
94100

95101
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
96-
| --- | --- | --- | --- | --- |
97-
| IE10, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
98-
102+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
103+
| IE10, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
99104

100105
## Contributors
101106

102-
This project exists thanks to all the people who contribute.
107+
This project exists thanks to all the people who contribute.
103108
<a href="https://github.com/vueComponent/ant-design-vue-pro/graphs/contributors"><img src="https://opencollective.com/ant-design-pro-vue/contributors.svg?width=890&button=false" /></a>

README.zh-CN.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[English](./README.md) | 简体中文
22

3-
<h1 align="center">Ant Design Vue Pro</h1>
3+
<h1 align="center">Ant Design Vue Pro for Vue 2</h1>
44
<div align="center">
55
An out-of-box UI solution for enterprise applications as a Vue boilerplate. based on <a href="https://vuecomponent.github.io/ant-design-vue/docs/vue/introduce-cn/" target="_blank">Ant Design of Vue</a>
66
</div>
77

8+
<div align="center">
9+
如果需要 Vue 3 版本,请访问 [Ant Design Vue Pro for Vue 3](https://store.antdv.com/items/admin-pro)
10+
</div>
11+
812
<div align="center">
913

1014
[![License](https://img.shields.io/npm/l/package.json.svg?style=flat)](https://github.com/vueComponent/ant-design-vue-pro/blob/master/LICENSE)
@@ -21,15 +25,13 @@ An out-of-box UI solution for enterprise applications as a Vue boilerplate. base
2125
- 常见问题: https://pro.antdv.com/docs/faq
2226
- Vue3 ProLayout: https://github.com/vueComponent/pro-layout
2327

24-
Overview
25-
----
28+
## Overview
2629

27-
基于 [Ant Design of Vue](https://vuecomponent.github.io/ant-design-vue/docs/vue/introduce-cn/) 实现的 [Ant Design Pro](https://pro.ant.design/)
30+
基于 [Ant Design of Vue](https://vuecomponent.github.io/ant-design-vue/docs/vue/introduce-cn/) 实现的 [Ant Design Pro](https://pro.ant.design/)
2831

2932
![dashboard](https://static-2.loacg.com/open/static/github/SP1.png)
3033

31-
环境和依赖
32-
----
34+
## 环境和依赖
3335

3436
- node
3537
- yarn
@@ -39,53 +41,52 @@ Overview
3941
- [[email protected]](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue 实现
4042
- [vue-cropper](https://github.com/xyxiao001/vue-cropper) - 头像裁剪组件
4143
- [@antv/g2](https://antv.alipay.com/zh-cn/index.html) - Alipay AntV 数据可视化图表
42-
- [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation) - antv/g2 封装实现
44+
- [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation) - antv/g2 封装实现
4345

4446
> 请注意,我们强烈建议本项目使用 [Yarn](https://yarnpkg.com/) 包管理工具,这样可以与本项目演示站所加载完全相同的依赖版本 (yarn.lock) 。由于我们没有对依赖进行强制的版本控制,采用非 yarn 包管理进行引入时,可能由于 Pro 所依赖的库已经升级版本而引入了新版本所导致的问题。作者可能会由于时间问题无法及时排查而导致您采用本项目作为基项目而出现问题。
4547
46-
47-
48-
项目下载和运行
49-
----
48+
## 项目下载和运行
5049

5150
- 拉取项目代码
51+
5252
```bash
5353
git clone https://github.com/vueComponent/ant-design-vue-pro.git
5454
cd ant-design-vue-pro
5555
```
5656

5757
- 安装依赖
58+
5859
```
5960
yarn install
6061
```
6162

6263
- 开发模式运行
64+
6365
```
6466
yarn run serve
6567
```
6668

6769
- 编译项目
70+
6871
```
6972
yarn run build
7073
```
7174

7275
- Lints and fixes files
76+
7377
```
7478
yarn run lint
7579
```
7680

81+
## 其他说明
7782

78-
79-
其他说明
80-
----
81-
82-
- **关于 Issue 反馈 (重要!重要!重要!) 请在开 *Issue* 前,先阅读该内容:[Issue / PR 编写建议](https://github.com/vueComponent/ant-design-vue-pro/issues/90)**
83+
- **关于 Issue 反馈 (重要!重要!重要!) 请在开 _Issue_ 前,先阅读该内容:[Issue / PR 编写建议](https://github.com/vueComponent/ant-design-vue-pro/issues/90)**
8384

8485
- 项目使用的 [vue-cli3](https://cli.vuejs.org/guide/), 请确保你所使用的 vue-cli 是新版,并且已经学习 cli 官方文档使用教程
8586

8687
- 关闭 Eslint (不推荐) 移除 `package.json``eslintConfig` 整个节点代码, `vue.config.js` 下的 `lintOnSave` 值改为 `false`
8788

88-
- 组件按需加载 `/src/main.js` L14 相关代码 `import './core/lazy_use'` / `import './core/use'`
89+
- 组件按需加载 `/src/main.js` L14 相关代码 `import './core/lazy_use'` / `import './core/use'`
8990

9091
- [修改 Ant Design 配色 (@kokoroli)](https://github.com/kokoroli/antd-awesome/blob/master/docs/Ant_Design_%E6%A0%B7%E5%BC%8F%E8%A6%86%E7%9B%96.md)
9192

@@ -100,11 +101,10 @@ yarn run lint
100101
Modern browsers and IE10.
101102

102103
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Opera |
103-
| --- | --- | --- | --- | --- |
104-
| IE10, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
105-
104+
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
105+
| IE10, Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
106106

107107
## Contributors
108108

109-
This project exists thanks to all the people who contribute.
109+
This project exists thanks to all the people who contribute.
110110
<a href="https://github.com/vueComponent/ant-design-vue-pro/graphs/contributors"><img src="https://opencollective.com/ant-design-pro-vue/contributors.svg?width=890&button=false" /></a>

0 commit comments

Comments
 (0)