mirror of
https://gitee.com/antv/g6.git
synced 2024-12-02 19:58:46 +08:00
docs: update readme (#5193)
This commit is contained in:
parent
3932df6c69
commit
8604d82434
4
.github/workflows/deploy.yml
vendored
4
.github/workflows/deploy.yml
vendored
@ -10,6 +10,10 @@ jobs:
|
||||
deploy-site:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 16
|
||||
- uses: pnpm/action-setup@v2
|
||||
with:
|
||||
version: 8
|
||||
|
@ -127,13 +127,14 @@ For more information of the usage, please refer to [Getting Started](https://g6.
|
||||
## Development
|
||||
|
||||
```bash
|
||||
$ npm install
|
||||
# install dependencies (with pnpm)
|
||||
pnpm install
|
||||
|
||||
# lerna bootstrap for multiple packages
|
||||
$ npm run bootstrap
|
||||
# build
|
||||
pnpm build
|
||||
|
||||
# build the packages
|
||||
$ npm run build:all
|
||||
# start the dev server
|
||||
pnpm start
|
||||
|
||||
# if you wanna watch one of the packages, e.g. packages/core
|
||||
$ cd ./packages/core
|
||||
@ -186,19 +187,6 @@ Welcome to join the **G6 Communication Group** or **G6 Communication Group-2** (
|
||||
|
||||
Please let us know what you are you going to help. Do check out [issues](https://github.com/antvis/g6/issues) for bug reports or suggestions first.
|
||||
|
||||
### Start Project
|
||||
|
||||
```bash
|
||||
# Install dependencies (with pnpm)
|
||||
pnpm install
|
||||
|
||||
# Build
|
||||
pnpm build
|
||||
|
||||
# Start the dev server
|
||||
pnpm start
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT license](./LICENSE).
|
||||
|
30
README.md
30
README.md
@ -142,17 +142,18 @@ graph.render();
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
$ npm install
|
||||
# 安装依赖 (请使用 pnpm)
|
||||
pnpm install
|
||||
|
||||
# lerna bootstrap for multiple packages
|
||||
$ npm run bootstrap
|
||||
# 构建
|
||||
pnpm build
|
||||
|
||||
# build the packages
|
||||
$ npm run build:all
|
||||
# 启动站点
|
||||
pnpm start
|
||||
|
||||
# if you wanna watch one of the packages, e.g. packages/core
|
||||
$ cd ./packages/core
|
||||
$ npm run watch
|
||||
# 更新子包, 例如 packages/core
|
||||
cd ./packages/core
|
||||
npm run watch
|
||||
|
||||
# run test case
|
||||
$ npm test
|
||||
@ -205,19 +206,6 @@ DEBUG_MODE=1 npm test -- --watch ./tests/unit/algorithm/find-path-spec
|
||||
|
||||
请让我们知道您要解决或贡献什么,所以在贡献之前请先提交 [issues](https://github.com/antvis/g6/issues) 描述 bug 或建议。
|
||||
|
||||
### 项目启动
|
||||
|
||||
```bash
|
||||
# 安装依赖 (请使用 pnpm)
|
||||
pnpm install
|
||||
|
||||
# 构建
|
||||
pnpm build
|
||||
|
||||
# 启动站点
|
||||
pnpm start
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT license](./LICENSE).
|
||||
|
Loading…
Reference in New Issue
Block a user