diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dda6efb8c31..cb4997d5d76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ No one can guarantee how much will be remembered about certain PR after some tim ### Style Guide -eslint can help to identify styling issues that may exist in your code. Your code is required to pass the test from eslint. Run the test locally by `$ yarn lint`. +eslint can help to identify styling issues that may exist in your code. Your code is required to pass the test from eslint. Run the test locally by `$ npm run lint`. ### Commit Message Format diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 21497c92eb1..9c99286f868 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -41,7 +41,7 @@ $ git push origin branch-name ### 代码风格 -你的代码风格必须通过 eslint,你可以运行 `$ yarn lint` 本地测试。 +你的代码风格必须通过 eslint,你可以运行 `$ npm run lint` 本地测试。 ### Commit 提交规范 diff --git a/README.en-us.md b/README.en-us.md index aca0faa6789..1a930d753bf 100644 --- a/README.en-us.md +++ b/README.en-us.md @@ -33,8 +33,8 @@ - Server-side Rendering | [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 | -| --- | --- | --- | --- | -| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | ## Installation @@ -94,20 +94,16 @@ graph.addEdge({ ## Development ```shell -# install yarn and lerna -$ npm install yarn -g -$ npm install lerna -g - # install deps and build -$ yarn bootstrap +$ pnpm install # enter the specified project development and debugging cd packages/x6 -yarn build:watch +pnpm run build:watch # start example to see the effect cd examples/x6-example-features -yarn start +pnpm run start ``` ## Contributing diff --git a/README.md b/README.md index 9f58ee05db9..692bb0f93a2 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ - 支持服务端渲染。 | [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 | -| --- | --- | --- | --- | -| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IE11, Edge | last 2 versions | last 2 versions | last 2 versions | ## 安装 @@ -94,20 +94,16 @@ graph.addEdge({ ## 本地开发 ```shell -# 全局安装 yarn 和 lerna 工具 -$ npm install yarn -g -$ npm install lerna -g - # 安装项目依赖和初始化构建 -$ yarn bootstrap +$ pnpm install # 进入到指定项目开发和调试 cd packages/x6 -yarn build:watch +pnpm run build:watch # 启动 example 查看效果 cd examples/x6-example-features -yarn start +pnpm run start ``` ## 参与共建