From 41f5809e667a167d1b429f459f80d3fd5f7da9eb Mon Sep 17 00:00:00 2001 From: Kagol Date: Fri, 31 Mar 2023 06:55:03 +0800 Subject: [PATCH] docs: update README (#98) --- CONTRIBUTING.md | 14 +++++++------- CONTRIBUTING.zh-CN.md | 14 +++++++------- README.md | 8 ++++---- README.zh-CN.md | 8 ++++---- package.json | 2 +- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fa9542ec..946564048 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,9 +41,9 @@ Local startup steps: - Click the Fork button in the upper right corner of the [TinyVue](https://github.com/opentiny/tiny-vue) code repository to Fork the upstream repository to the personal repository. - Clone personal repository to local. - Associated with the upstream repository to facilitate the synchronization of the latest code of the upstream repository. -- Run `npm i --force` under the TinyVue root directory to install node dependencies. -- Run `npm run dev:vue3` to launch the component library website. -- Open the browser to visit: [http://127.0.0.1:5173/](http://127.0.0.1:5173/) +- Run `pnpm i` under the TinyVue root directory to install node dependencies. +- Run `pnpm dev` to launch the component library website. +- Open the browser to visit: [http://127.0.0.1:6175/](http://127.0.0.1:6175/) ```shell # You need to replace username with your own user name @@ -54,18 +54,18 @@ cd tiny-vue git remote add upstream git@github.com:opentiny/tiny-vue.git # Installation -npm i +pnpm i # Launch Vue.js 3 -npm run dev:vue3 +pnpm dev # Launch Vue.js 2 -npm run dev:vue2 +pnpm dev:vue2 ``` To submit a PR: -- Make sure that you have completed the steps in local startup and can visit [http://127.0.0.1:5173/](http://127.0.0.1:5173/) normally. +- Make sure that you have completed the steps in local startup and can visit [http://127.0.0.1:6175/](http://127.0.0.1:6175/) normally. - Synchronize upstream repository dev branch latest code: `git pull upstream dev`. - Create a new branch `git checkout-b username/feature1 upstream/ dev` from the upstream repository dev branch. The name of the branch should be `username/feat- xxx` / `username/fix- xxx`. - Local coding. diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 39108e37a..2c34ee273 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -41,9 +41,9 @@ - 点击 [TinyVue](https://github.com/opentiny/tiny-vue) 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库 - Clone 个人仓库到本地 - 关联上游仓库，方便同步上游仓库最新代码 -- 在 Tiny Vue 根目录下运行 `npm i --force`, 安装 node 依赖 -- 运行 npm run dev:vue3，启动组件库网站 -- 打开浏览器访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/) +- 在 Tiny Vue 根目录下运行 `pnpm i`, 安装 node 依赖 +- 运行 `pnpm dev`，启动组件库网站 +- 打开浏览器访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/) ```shell # username 为用户名，执行前请替换 @@ -54,18 +54,18 @@ cd tiny-vue git remote add upstream git@github.com:opentiny/tiny-vue.git # 安装依赖 -npm i +pnpm i # 启动 Vue3 项目 -npm run dev:vue3 +pnpm dev # 启动 Vue2 项目 -npm run dev:vue2 +pnpm dev:vue2 ``` 提交 PR 的步骤： -- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/) +- 请确保你已经完成本地启动中的步骤，并能正常访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/) - 同步上游仓库 dev 分支最新代码：git pull upstream dev - 从上游仓库 dev 分支创建新分支 `git checkout -b username/feature1 upstream/dev`，分支名字建议为 `username/feat-xxx` / `username/fix-xxx` - 本地编码 diff --git a/README.md b/README.md index cea20f91d..f9284c59c 100644 --- a/README.md +++ b/README.md @@ -53,16 +53,16 @@ import { Button as TinyButton } from '@opentiny/vue' ```shell git clone git@github.com:opentiny/tiny-vue.git cd tiny-vue -npm i --legacy-peer-deps +pnpm i # Vue.js 3 -npm run dev:vue3 +pnpm dev # Vue.js 2 -npm run dev:vue2 +pnpm dev:vue2 ``` -Open your browser and visit: [http://127.0.0.1:5173/](http://127.0.0.1:5173/) +Open your browser and visit: [http://127.0.0.1:6175/](http://127.0.0.1:6175/) ## 🤝 Contributing diff --git a/README.zh-CN.md b/README.zh-CN.md index fd12c00ec..fffe0ce74 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -53,16 +53,16 @@ import { Button as TinyButton } from '@opentiny/vue' ```shell git clone git@github.com:opentiny/tiny-vue.git cd tiny-vue -npm i --legacy-peer-deps +pnpm i # 启动 Vue3 项目 -npm run dev:vue3 +pnpm dev # 启动 Vue2 项目 -npm run dev:vue2 +pnpm dev:vue2 ``` -打开浏览器访问：[http://127.0.0.1:5173/](http://127.0.0.1:5173/) +打开浏览器访问：[http://127.0.0.1:6175/](http://127.0.0.1:6175/) ## 🤝 参与贡献 diff --git a/package.json b/package.json index 0e2a3bbe8..918aa0da7 100644 --- a/package.json +++ b/package.json @@ -41,9 +41,9 @@ "preinstall": "npx only-allow pnpm", "postinstall": "pnpm build:internals", "bootstrap": "pnpm --filter=\"!./packages/dist/**\" install", + "dev": "pnpm -C examples/vue3 dev", "dev:vue2": "pnpm -C examples/vue2 dev", "dev:vue2.7": "pnpm -C examples/vue2.7 dev", - "dev:vue3": "pnpm -C examples/vue3 dev", "dev:docs": "pnpm -C examples/docs docs:dev", "build:entry": "pnpm -C internals/cli build:entry", "create:ui": "pnpm -C internals/cli create:ui",