Merge pull request #40 from hu-xin-fin/v1.0.2

add en readme
Octoveau · Feb 15, 2023 · fe5d3ef · fe5d3ef
2 parents 7a3f793 + 31456e9
commit fe5d3ef
Show file tree

Hide file tree

Showing 2 changed files with 168 additions and 54 deletions.
diff --git a/README.es.md b/README.es.md
@@ -0,0 +1,55 @@
+<h1 style="text-align: center">Vue2 Template Admin</h1>
+
+[README IN Chinese](https://github.com/Octoveau/vue2-element-admin-thin/blob/main/README.md)
+## Introduction
+
+Vue2 Template Admin as a middle-background template, which is developed with `vue2`, `element-ui` and other related technology stacks.   There are built-in secondary-encapsulates frequently-use components.   Refine and abstract frequently-use modules, reduce the use of `import` and `require`, improve development efficiency
+
+## Features
+
+- Module: Highly abstract, minimize the use of `import` and `require`
+- Component: Secondary-encapsulate for multiple frequently-use componen
+
+## Preparation
+
+This project is mainly based on `ES2015+`, `vue2`, `Vue-router`, `pinia`, `[email protected]`, `axios` and` ant design for vue `, you need to be familiar with in advance.
+
+- node and git - Project development environment
+- be acquainted with vue2 essentials syntax
+- be acquainted with webpack features, not limited to (webpackDLL, ProvidePlugin, plugin alias), etc
+- Since the project is highly abstract against typical modules such as` auth `, `utils`, etc., you need to consult the vue.config.js file beforehand
+
+## Installation and use
+
+```
+- Pull project
+git clone https://github.com/Octoveau/vue2-template-portal.git
+
+- Into the project
+cd vue2-template-portal
+
+- Installation dependency
+npm install
+
+- Start
+npm run serve
+```
+
+## Others
+```
+- Prepack [Prepack 'ant design for vue', 'moment', and 'lodash' to improve compilation speed]
+npm run dll
+```
+
+
+## commit title must followed by a space character
+
+- build: The submission is mainly about modify the building system of the project (e.g. glup, webpack, rollup configuration, etc.)
+- ci: The submission is mainly about modify the submission of the project continuing integration process (e.g. Travis, Jenkins, GitLab CI, Circle, etc.)
+- docs: Updates the document
+- feat: New function
+- fix: Fixed bugs
+- perf: performance optimization
+- refactor: Refactor the code (neither new features nor bug fixes)
+-style: Code modification that does not affect program logic (modify whitespace characters, completing missing semicolons, etc.)
+- test: Add test case or update existing test
diff --git a/README.md b/README.md
@@ -1,54 +1,113 @@
-<h1 style="text-align: center">Vue2 Template Admin</h1>
-
-## 简介
-
-Vue2 Template Admin 作为中后台模版，其采用`vue2`，`element-ui`等相关技术栈开发。内置二次封装的常规组件，提炼并抽象化常用模块，减轻`import`与`require`的使用，提升开发效率
-
-## 特性
-
-- 模块：高度抽象，尽量减少`import`和`require`使用
-- 组件：二次封装多个常用组件
-
-## 准备
-
-本项目主要基于`ES2015+`，`vue2`，`vue-router`，`pinia`，`[email protected]`，`axios`及`ant design for vue`，故需要提前熟悉。
-
-- node 和 git -项目开发环境
-- 熟悉 vue2 基础语法
-- 熟悉 webpack 特性，不限于（webpackDLL、ProvidePlugin、plugin alias）等
-- 由于项目针对典型模块如`auth`，`utils`等高度抽象，需要预先查阅 vue.config.js 文件
-
-## 安装及使用
-
-```
-- 拉取项目
-git clone https://github.com/Octoveau/vue2-template-portal.git
-
-- 进入项目
-cd vue2-template-portal
-
-- 安装依赖
-npm install
-
-- 启动
-npm run serve
-```
-
-## 其它
-
-```
-- 预打包【将ant design for vue、moment、lodash进行预打包提高编译速度】
-npm run dll
-```
-
-## commit 时的标题，后面必须代一个空格
-
-- build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
-- ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle 等)的提交
-- docs：文档更新
-- feat：新增功能
-- fix：bug 修复
-- perf：性能优化
-- refactor：重构代码(既没有新增功能，也没有修复 bug)
-- style：不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等)
-- test：新增测试用例或是更新现有测试
+
+<h1 style="text-align: center">Vue2 Template Admin</h1>
+
+[README IN English](https://github.com/Octoveau/vue2-element-admin-thin/blob/main/README.es.md)
+
+## 简介
+
+Vue2 Template Admin 作为中后台模版，其采用`vue2`，`element-ui`等相关技术栈开发。内置二次封装的常用组件，提炼并抽象化常用模块，减轻`import`与`require`的使用，提升开发效率
+
+## 特性
+
+- 模块：高度抽象，尽量减少`import`和`require`使用
+- 组件：二次封装多个常用组件
+
+## 准备
+
+本项目主要基于`ES2015+`，`vue2`，`vue-router`，`pinia`，`[email protected]`，`axios`及`ant design for vue`，故需要提前熟悉。
+
+- node 和 git -项目开发环境
+- 熟悉 vue2 基础语法
+- 熟悉 webpack 特性，不限于（webpackDLL、ProvidePlugin、plugin alias）等
+- 由于项目针对典型模块如`auth`，`utils`等高度抽象，需要预先查阅 vue.config.js 文件
+
+## 安装及使用
+
+```
+- 拉取项目
+git clone https://github.com/Octoveau/vue2-template-portal.git
+
+- 进入项目
+cd vue2-template-portal
+
+- 安装依赖
+npm install
+
+- 启动
+npm run serve
+```
+
+## 其它
+
+```
+- 预打包【将ant design for vue、moment、lodash进行预打包提高编译速度】
+npm run dll
+```
+
+## commit 时的标题，后面必须代一个空格
+
+- build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
+- ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle 等)的提交
+- docs：文档更新
+- feat：新增功能
+- fix：bug 修复
+- perf：性能优化
+- refactor：重构代码(既没有新增功能，也没有修复 bug)
+- style：不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等)
+- test：新增测试用例或是更新现有测试
+=======
+<h1 style="text-align: center">Vue2 Template Admin</h1>
+
+## 简介
+
+Vue2 Template Admin 作为中后台模版，其采用`vue2`，`element-ui`等相关技术栈开发。内置二次封装的常规组件，提炼并抽象化常用模块，减轻`import`与`require`的使用，提升开发效率
+
+## 特性
+
+- 模块：高度抽象，尽量减少`import`和`require`使用
+- 组件：二次封装多个常用组件
+
+## 准备
+
+本项目主要基于`ES2015+`，`vue2`，`vue-router`，`pinia`，`[email protected]`，`axios`及`ant design for vue`，故需要提前熟悉。
+
+- node 和 git -项目开发环境
+- 熟悉 vue2 基础语法
+- 熟悉 webpack 特性，不限于（webpackDLL、ProvidePlugin、plugin alias）等
+- 由于项目针对典型模块如`auth`，`utils`等高度抽象，需要预先查阅 vue.config.js 文件
+
+## 安装及使用
+
+```
+- 拉取项目
+git clone https://github.com/Octoveau/vue2-template-portal.git
+
+- 进入项目
+cd vue2-template-portal
+
+- 安装依赖
+npm install
+
+- 启动
+npm run serve
+```
+
+## 其它
+
+```
+- 预打包【将ant design for vue、moment、lodash进行预打包提高编译速度】
+npm run dll
+```
+
+## commit 时的标题，后面必须代一个空格
+
+- build：主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
+- ci：主要目的是修改项目继续集成流程(例如 Travis，Jenkins，GitLab CI，Circle 等)的提交
+- docs：文档更新
+- feat：新增功能
+- fix：bug 修复
+- perf：性能优化
+- refactor：重构代码(既没有新增功能，也没有修复 bug)
+- style：不影响程序逻辑的代码修改(修改空白字符，补全缺失的分号等)
+- test：新增测试用例或是更新现有测试
+