diff --git a/ README-en_US.md b/ README-en_US.md deleted file mode 100644 index f8f7453..0000000 --- a/ README-en_US.md +++ /dev/null @@ -1,97 +0,0 @@ -

- -

-

- - 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.md b/README.md index beed009..dd5ed69 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,12 @@ English | [简体中文](./README-zh_CN.md) ### Introduction -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 . +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.

- preview + Live Preview · - documentation - + Documentation

@@ -31,22 +30,22 @@ TDesign Vue Next Starter is a TDesign-based, developed with `Vue3`, `Vite2`, `Pi ### Features - Various provided pages for develop -- Complete Directory Structure for develop -- Code Specification Configuration -- Dark Mode +- Complete directory structure for develop +- Code specification configuration +- Support dark mode - Custom theme colors - Various space layouts -- Mock Data Scheme +- Mock data scheme ### Usage -> init project with our CLI tool `tdesign-starter-cli` +> Initialize project with our CLI tool `tdesign-starter-cli` ```bash ## install tdesign-starter-cli npm i tdesign-starter-cli@latest -g -## 2、create project +## create project td-starter init ``` @@ -71,9 +70,9 @@ npm run build:test ``` -### Contributing +### Contributing Guide -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)。 +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 @@ -94,6 +93,6 @@ Contributing is welcome！Create your [Issue](https://github.com/tencent/tdesign | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Edge >=84 | Firefox >=83 | Chrome >=84 | Safari >=14.1 | -### LICENSE +### License -[MIT](https://github.com/Tencent/tdesign-vue-next-starter/LICENSE) +The MIT License. Please see [the license file](LICENSE) for more information.