Browse Source

[doc]Update

dufu1991 3 years ago
parent
commit
a28588f76a
2 changed files with 26 additions and 0 deletions
  1. 13 0
      doc/guide/contribution.md
  2. 13 0
      doc/guide/contribution_en.md

+ 13 - 0
doc/guide/contribution.md

@@ -19,10 +19,23 @@
 
 按照下面的步骤操作,即可在本地快速启动 STDF Demo。
 
+>由于 Demo 依赖的 stdf 和 rollup-plugin-stdf-icon 包都是本地构建的,所以请先构建一下这两个包。
+
 ```bash
 ## 克隆 STDF 仓库
 git clone git@github.com:dufu1991/stdf.git
 
+## 构建一下 STDF package
+cd stdf/packages/stdf
+npm run dist
+
+## 构建一下 rollup-plugin-stdf-icon package
+cd stdf/packages/rollup-plugin-stdf-icon
+pnpm i
+## or
+npm i
+npm run build
+
 ## 进入项目 demo 目录
 cd stdf/demo
 

+ 13 - 0
doc/guide/contribution_en.md

@@ -19,10 +19,23 @@ Debugging STDF requires an engineering environment. For this purpose, a simple D
 
 Follow the steps below to quickly start the STDF Demo locally.
 
+>Because the stdf and rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build these two packages first.
+
 ```bash
 ## Clone STDF repository
 git clone git@github.com:dufu1991/stdf.git
 
+## build STDF package
+cd packages/stdf
+npm run dist
+
+## build rollup-plugin-stdf-icon package
+cd packages/rollup-plugin-stdf-icon
+pnpm i
+## or
+npm i
+npm run build
+
 ## Enter the project demo directory
 cd stdf/demo