Commit 616df9e

author

oscars.skittles@gmail.com

committed

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 616df9eCopy full SHA for 616df9e

File tree

2 files changed

+40

-35

lines changed

README.md
README.zh-CN.md

2 files changed

+40

-35

lines changed

`‎README.md‎`

Lines changed: 19 additions & 14 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,14 @@`
`1`	`1`	`English \| [简体中文](./README.zh-CN.md)`
`2`	`2`
`3`		`-<h1 align="center">Ant Design Vue Pro</h1>`
	`3`	`+<h1 align="center">Ant Design Vue Pro for Vue 2</h1>`
`4`	`4`	`<div align="center">`
`5`	`5`	`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>`
`6`	`6`	`</div>`
`7`	`7`
	`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`	`+`
`8`	`12`	`<div align="center">`
`9`	`13`
`10`	`14`	`[![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`
`21`	`25`	`- FAQ: https://pro.antdv.com/docs/faq`
`22`	`26`	`- Vue3 ProLayout: https://github.com/vueComponent/pro-layout`
`23`	`27`
`24`		`-Overview`
`25`		`-----`
	`28`	`+## Overview`
`26`	`29`
`27`	`30`	`![dashboard](https://static-2.loacg.com/open/static/github/SP1.png)`
`28`	`31`
`@@ -33,54 +36,57 @@ Overview`
`33`	`36`	`- webpack`
`34`	`37`	`- eslint`
`35`	`38`	`- @vue/cli`
`36`		`-- [ant-design-vue@1.x](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue`
	`39`	`+- [ant-design-vue@1.x](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue`
`37`	`40`	`- [vue-cropper](https://github.com/xyxiao001/vue-cropper) - Picture edit`
`38`	`41`	`- [@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`
`42`	`43`
	`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`
`43`	`45`
`44`	`46`	`### Project setup`
`45`	`47`
`46`	`48`	`- Clone repo`
	`49`	`+`
`47`	`50`	```bash
`48`	`51`	`git clone https://github.com/vueComponent/ant-design-vue-pro.git`
`49`	`52`	`cd ant-design-vue-pro`
`50`	`53`	```
`51`	`54`
`52`	`55`	`- Install dependencies`
	`56`	`+`
`53`	`57`	```
`54`	`58`	`yarn install`
`55`	`59`	```
`56`	`60`
`57`	`61`	`- Compiles and hot-reloads for development`
	`62`	`+`
`58`	`63`	```
`59`	`64`	`yarn run serve`
`60`	`65`	```
`61`	`66`
`62`	`67`	`- Compiles and minifies for production`
	`68`	`+`
`63`	`69`	```
`64`	`70`	`yarn run build`
`65`	`71`	```
`66`	`72`
`67`	`73`	`- Lints and fixes files`
	`74`	`+`
`68`	`75`	```
`69`	`76`	`yarn run lint`
`70`	`77`	```
`71`	`78`
`72`		`-`
`73`	`79`	`### Other`
`74`	`80`
`75`	`81`	`- IMPORTANT : Issue feedback !! when opening Issue read [Issue / PR Contributing](https://github.com/vueComponent/ant-design-vue-pro/issues/90)`
`76`	`82`
`77`	`83`	`- [Vue-cli3](https://cli.vuejs.org/guide/) used by the project.`
`78`	`84`
`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`
`80`	`86`
`81`	`87`	- 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)
`82`	`88`
`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)`
`84`	`90`
`85`	`91`	`- I18n: [locales (@musnow)](./src/locales/index.js)`
`86`	`92`
`@@ -93,11 +99,10 @@ yarn run lint`
`93`	`99`	`Modern browsers and IE10.`
`94`	`100`
`95`	`101`	\| [<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 \|`
`99`	`104`
`100`	`105`	`## Contributors`
`101`	`106`
`102`		`-This project exists thanks to all the people who contribute.`
	`107`	`+This project exists thanks to all the people who contribute.`
`103`	`108`	`<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 number	Diff line number	Diff line change
`@@ -1,10 +1,14 @@`
`1`	`1`	`[English](./README.md) \| 简体中文`
`2`	`2`
`3`		`-<h1 align="center">Ant Design Vue Pro</h1>`
	`3`	`+<h1 align="center">Ant Design Vue Pro for Vue 2</h1>`
`4`	`4`	`<div align="center">`
`5`	`5`	`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>`
`6`	`6`	`</div>`
`7`	`7`
	`8`	`+<div align="center">`
	`9`	`+ 如果需要 Vue 3 版本,请访问 [Ant Design Vue Pro for Vue 3](https://store.antdv.com/items/admin-pro)`
	`10`	`+</div>`
	`11`	`+`
`8`	`12`	`<div align="center">`
`9`	`13`
`10`	`14`	`[![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`
`21`	`25`	`- 常见问题: https://pro.antdv.com/docs/faq`
`22`	`26`	`- Vue3 ProLayout: https://github.com/vueComponent/pro-layout`
`23`	`27`
`24`		`-Overview`
`25`		`-----`
	`28`	`+## Overview`
`26`	`29`
`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/)`
`28`	`31`
`29`	`32`	`![dashboard](https://static-2.loacg.com/open/static/github/SP1.png)`
`30`	`33`
`31`		`-环境和依赖`
`32`		`-----`
	`34`	`+## 环境和依赖`
`33`	`35`
`34`	`36`	`- node`
`35`	`37`	`- yarn`
`@@ -39,53 +41,52 @@ Overview`
`39`	`41`	`- [ant-design-vue@1.x](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue 实现`
`40`	`42`	`- [vue-cropper](https://github.com/xyxiao001/vue-cropper) - 头像裁剪组件`
`41`	`43`	`- [@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 封装实现`
`43`	`45`
`44`	`46`	`> 请注意,我们强烈建议本项目使用 [Yarn](https://yarnpkg.com/) 包管理工具,这样可以与本项目演示站所加载完全相同的依赖版本 (yarn.lock) 。由于我们没有对依赖进行强制的版本控制,采用非 yarn 包管理进行引入时,可能由于 Pro 所依赖的库已经升级版本而引入了新版本所导致的问题。作者可能会由于时间问题无法及时排查而导致您采用本项目作为基项目而出现问题。`
`45`	`47`
`46`		`-`
`47`		`-`
`48`		`-项目下载和运行`
`49`		`-----`
	`48`	`+## 项目下载和运行`
`50`	`49`
`51`	`50`	`- 拉取项目代码`
	`51`	`+`
`52`	`52`	```bash
`53`	`53`	`git clone https://github.com/vueComponent/ant-design-vue-pro.git`
`54`	`54`	`cd ant-design-vue-pro`
`55`	`55`	```
`56`	`56`
`57`	`57`	`- 安装依赖`
	`58`	`+`
`58`	`59`	```
`59`	`60`	`yarn install`
`60`	`61`	```
`61`	`62`
`62`	`63`	`- 开发模式运行`
	`64`	`+`
`63`	`65`	```
`64`	`66`	`yarn run serve`
`65`	`67`	```
`66`	`68`
`67`	`69`	`- 编译项目`
	`70`	`+`
`68`	`71`	```
`69`	`72`	`yarn run build`
`70`	`73`	```
`71`	`74`
`72`	`75`	`- Lints and fixes files`
	`76`	`+`
`73`	`77`	```
`74`	`78`	`yarn run lint`
`75`	`79`	```
`76`	`80`
	`81`	`+## 其他说明`
`77`	`82`
`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)`
`83`	`84`
`84`	`85`	`- 项目使用的 [vue-cli3](https://cli.vuejs.org/guide/), 请确保你所使用的 vue-cli 是新版,并且已经学习 cli 官方文档使用教程`
`85`	`86`
`86`	`87`	- 关闭 Eslint (不推荐) 移除 `package.json` 中 `eslintConfig` 整个节点代码, `vue.config.js` 下的 `lintOnSave` 值改为 `false`
`87`	`88`
`88`		-- 组件按需加载 `/src/main.js` L14 相关代码 `import './core/lazy_use'` / `import './core/use'`
	`89`	+- 组件按需加载 `/src/main.js` L14 相关代码 `import './core/lazy_use'` / `import './core/use'`
`89`	`90`
`90`	`91`	`- [修改 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)`
`91`	`92`
`@@ -100,11 +101,10 @@ yarn run lint`
`100`	`101`	`Modern browsers and IE10.`
`101`	`102`
`102`	`103`	\| [<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 \|`
`106`	`106`
`107`	`107`	`## Contributors`
`108`	`108`
`109`		`-This project exists thanks to all the people who contribute.`
	`109`	`+This project exists thanks to all the people who contribute.`
`110`	`110`	`<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)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 616df9e

File tree

2 files changed

2 files changed

`‎README.md‎`

`‎README.zh-CN.md‎`

0 commit comments