From 7e40754fc179c28f8e02844018cf36faa701ba15 Mon Sep 17 00:00:00 2001 From: yuyang Date: Tue, 13 Sep 2022 16:42:51 +0800 Subject: [PATCH] docs: README in English (#301) * fix: miss layout header * docs: readme in english * fix: typo and grammar (#300) * chore: add lang tab Co-authored-by: Thet Paing Hein --- README-en_US.md | 97 ++++++++++++++++++++++++++++++++++++++ README-zh_CN.md | 120 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 91 ++++++++++++++--------------------- 3 files changed, 253 insertions(+), 55 deletions(-) create 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 new file mode 100644 index 0000000..f8f7453 --- /dev/null +++ b/ README-en_US.md @@ -0,0 +1,97 @@ +

+ +

+

+ + TDesign Logo + +

+ +

+ node compatility + + License + +

+ +### Introduction + +TDesign Vue Next Starter is a TDesign-based developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`. It can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects. + +

+ Live Preview + · + Documentation +

+ + + +### Features + +- Various provided pages for develop +- Complete directory structure for develop +- Code specification configuration +- Support dark mode +- Custom theme colors +- Various space layouts +- Mock data scheme + +### Usage + +> Initialize project with our CLI tool `tdesign-starter-cli` + +```bash +## install tdesign-starter-cli +npm i tdesign-starter-cli@latest -g + +## create project +td-starter init +``` + +### Develop + +```bash +## install dependencies +npm install + +## set up +npm run dev +``` + +### Build + +```bash +## build +npm run build + +## build for test +npm run build:test +``` + + +### Contributing Guide + +We welcome contributions to our project. Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls). + +#### Pull Request + +1. Fork it! +2. Create your branch: `git checkout -b feat/xxxx` +3. Commit: `git commit -a 'feat(project): describe'` +4. Push: `git push origin feat/xxxx` +5. New Pull Request `pull request` + +#### Commit Specification + +- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) +- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories) + +### Compatibility + +| [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 | + +### License + +The MIT License. Please see [the license file](LICENSE) for more information. diff --git a/README-zh_CN.md b/README-zh_CN.md new file mode 100644 index 0000000..ad43c9c --- /dev/null +++ b/README-zh_CN.md @@ -0,0 +1,120 @@ + +

+ +

+

+ + TDesign Logo + +

+ +

+ node compatility + + License + +

+ +简体中文 | [English](./README.md) + +### 项目简介 + +TDesign Vue Next Starter 是一个基于 TDesign，使用 `Vue3`、`Vite2`、`Pinia`、`TypeScript` 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。 + +

+ 在线预览 + · + 使用文档 + +

+ + + +### 特性 + +- 内置多种常用的中后台页面 +- 完善的目录结构 +- 完善的代码规范配置 +- 支持暗黑模式 +- 自定义主题颜色 +- 多种空间布局 +- 内置 Mock 数据方案 + +### 使用 + +> 通过 `tdesign-starter-cli` 初始化项目仓库 + +```bash +## 1、安装 tdesign-starter-cli +npm i tdesign-starter-cli@latest -g + +## 2、创建项目 +td-starter init +``` + +### 开发 + +``` bash +## 安装依赖 +npm install + +## 启动项目 +npm run dev +``` + +### 构建 + +```bash +## 构建正式环境 +npm run build + +## 构建测试环境 +npm run build:test +``` + +### 其他 + +```bash +## 预览构建产物 +npm run preview + +## 代码格式检查 +npm run lint + +## 代码格式检查与自动修复 +npm run lint:fix + +## style格式检查 +npm run stylelint + +## style格式检查与自动修复 +npm run stylelint:fix +``` + +### 如何贡献 + +非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。 + +#### Pull Request + +1. Fork 代码! +2. 创建自己的分支: `git checkout -b feat/xxxx` +3. 提交你的修改: `git commit -a 'feat(project): describe'` +4. 推送您的分支: `git push origin feat/xxxx` +5. 提交 `pull request` + +#### 贡献提交规范 + +- [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) +- [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories) + +### 兼容性 + +| [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 | + +### 开源协议 + +TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)。 + diff --git a/README.md b/README.md index 1f15c15..beed009 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -

@@ -15,104 +14,86 @@

-### 项目简介 +English | [简体中文](./README-zh_CN.md) +### Introduction -TDesign Vue Next Starter 是一个基于 TDesign，使用 `Vue3`、`Vite2`、`Pinia`、`TypeScript` 开发，可进行个性化主题配置，旨在提供项目开箱即用的、配置式的中后台项目。 +TDesign Vue Next Starter is a TDesign-based, developed with `Vue3`, `Vite2`, `Pinia`, `TypeScript`, which can be customized theme configuration, and aims to provide project out-of-the-box, configuration-style middle and background projects .

- 在线预览 + preview · - 使用文档 + documentation

-### 特性 +### Features -- 内置多种常用的中后台页面 -- 完善的目录结构 -- 完善的代码规范配置 -- 支持暗黑模式 -- 自定义主题颜色 -- 多种空间布局 -- 内置 Mock 数据方案 +- Various provided pages for develop +- Complete Directory Structure for develop +- Code Specification Configuration +- Dark Mode +- Custom theme colors +- Various space layouts +- Mock Data Scheme -### 使用 +### Usage -> 通过 `tdesign-starter-cli` 初始化项目仓库 +> init project with our CLI tool `tdesign-starter-cli` ```bash -## 1、安装 tdesign-starter-cli +## install tdesign-starter-cli npm i tdesign-starter-cli@latest -g -## 2、创建项目 +## 2、create project td-starter init ``` -### 开发 +### Develop -``` bash -## 安装依赖 +```bash +## install dependencies npm install -## 启动项目 +## set up npm run dev ``` -### 构建 +### Build ```bash -## 构建正式环境 +## build npm run build -## 构建测试环境 +## build for test npm run build:test ``` -### 其他 -```bash -## 预览构建产物 -npm run preview +### Contributing -## 代码格式检查 -npm run lint - -## 代码格式检查与自动修复 -npm run lint:fix - -## style格式检查 -npm run stylelint - -## style格式检查与自动修复 -npm run stylelint:fix -``` - -### 如何贡献 - -非常欢迎您的贡献！提交您的 [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) 或者提交 [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。 +Contributing is welcome！Create your [Issue](https://github.com/tencent/tdesign-vue-next-starter/issues/new/choose) or Submit your [Pull Request](https://github.com/Tencent/tdesign-vue-next-starter/pulls)。 #### Pull Request -1. Fork 代码! -2. 创建自己的分支: `git checkout -b feat/xxxx` -3. 提交你的修改: `git commit -a 'feat(project): describe'` -4. 推送您的分支: `git push origin feat/xxxx` -5. 提交 `pull request` +1. Fork it! +2. Create your branch: `git checkout -b feat/xxxx` +3. Commit: `git commit -a 'feat(project): describe'` +4. Push: `git push origin feat/xxxx` +5. New Pull Request `pull request` -#### 贡献提交规范 +#### Commit Specification - [Angular Convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) - [Vue Style Guide](https://v3.vuejs.org/style-guide/#rule-categories) -### 兼容性 +### Compatibility | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 | +| Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 | -### 开源协议 - -TDesign 遵循 [MIT 协议](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)。 +### LICENSE +[MIT](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE)