dufu1991 3 лет назад
Родитель
Сommit
388ebfdc61
4 измененных файлов с 43 добавлено и 7 удалено
  1. 16 4
      doc/guide/contribution.md
  2. 15 3
      doc/guide/contribution_en.md
  3. 6 0
      doc/guide/quickStart.md
  4. 6 0
      doc/guide/quickStart_en.md

+ 16 - 4
doc/guide/contribution.md

@@ -30,25 +30,37 @@
 > 由于 Demo 依赖的 rollup-plugin-stdf-icon 包是本地构建的,所以请先构建一下这个包。
 > 由于 Demo 依赖的 rollup-plugin-stdf-icon 包是本地构建的,所以请先构建一下这个包。
 
 
 ```bash
 ```bash
-## 克隆 STDF 仓库
+## 1. 克隆 STDF 仓库
 git clone git@github.com:dufu1991/stdf.git
 git clone git@github.com:dufu1991/stdf.git
 
 
-## 构建一下 rollup-plugin-stdf-icon package
-cd stdf/packages/rollup-plugin-stdf-icon
+## 2. 构建 rollup-plugin-stdf-icon 包
+cd packages/rollup-plugin-stdf-icon
+
+## 安装依赖
+bun i
+## or
 pnpm i
 pnpm i
 ## or
 ## or
 npm i
 npm i
+
+## 构建包
+bun build
+## or
 npm run build
 npm run build
 
 
-## 进入项目 demo 目录
+## 3. 进入项目 demo 目录
 cd stdf/demo
 cd stdf/demo
 
 
 ## 安装依赖
 ## 安装依赖
+bun i
+## or
 pnpm i
 pnpm i
 ## or
 ## or
 npm i
 npm i
 
 
 ## 启动项目
 ## 启动项目
+bun dev
+## or
 npm run dev
 npm run dev
 ```
 ```
 
 

+ 15 - 3
doc/guide/contribution_en.md

@@ -28,25 +28,37 @@ Recommended installations:
 > Because the rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build this packages first.
 > Because the rollup-plugin-stdf-icon packages that the demo depends on are locally built, please build this packages first.
 
 
 ```bash
 ```bash
-## Clone STDF repository
+## 1. Clone STDF repository
 git clone git@github.com:dufu1991/stdf.git
 git clone git@github.com:dufu1991/stdf.git
 
 
-## build rollup-plugin-stdf-icon package
+## 2. Build rollup-plugin-stdf-icon package
 cd packages/rollup-plugin-stdf-icon
 cd packages/rollup-plugin-stdf-icon
+
+## Install dependencies
+bun i
+## or
 pnpm i
 pnpm i
 ## or
 ## or
 npm i
 npm i
+
+## Build package
+bun build
+## or
 npm run build
 npm run build
 
 
-## Enter the project demo directory
+## 3. Enter the project demo directory
 cd stdf/demo
 cd stdf/demo
 
 
 ## Install dependencies
 ## Install dependencies
+bun i
+## or
 pnpm i
 pnpm i
 ## or
 ## or
 npm i
 npm i
 
 
 ## Start the project
 ## Start the project
+bun dev
+## or
 npm run dev
 npm run dev
 ```
 ```
 
 

+ 6 - 0
doc/guide/quickStart.md

@@ -7,6 +7,8 @@
 已有配置好 Svelte 与 Tailwind 的工程,直接安装。
 已有配置好 Svelte 与 Tailwind 的工程,直接安装。
 
 
 ```bash
 ```bash
+bun i stdf -D
+# or
 pnpm i stdf -D
 pnpm i stdf -D
 # or
 # or
 npm i stdf -D
 npm i stdf -D
@@ -30,6 +32,8 @@ npm i stdf -D
 可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。(beta 版本)
 可以尝试使用 [create-stdf](https://www.npmjs.com/package/create-stdf) 快速创建工程。(beta 版本)
 
 
 ```bash
 ```bash
+bun create stdf
+# or
 pnpm create stdf
 pnpm create stdf
 # or
 # or
 npm create stdf@latest
 npm create stdf@latest
@@ -112,5 +116,7 @@ module.exports = {
 4. 启动项目。
 4. 启动项目。
 
 
 ```sh
 ```sh
+bun dev
+# or
 npm run dev
 npm run dev
 ```
 ```

+ 6 - 0
doc/guide/quickStart_en.md

@@ -7,6 +7,8 @@
 Svelte and Tailwind have been configured for direct installation.
 Svelte and Tailwind have been configured for direct installation.
 
 
 ```bash
 ```bash
+bun i stdf -D
+# or
 pnpm i stdf -D
 pnpm i stdf -D
 # or
 # or
 npm i stdf -D
 npm i stdf -D
@@ -30,6 +32,8 @@ npm i stdf -D
 You can try using [create-stdf](https://www.npmjs.com/package/create-stdf) to quickly create a project. (beta version)
 You can try using [create-stdf](https://www.npmjs.com/package/create-stdf) to quickly create a project. (beta version)
 
 
 ```bash
 ```bash
+bun create stdf
+# or
 pnpm create stdf
 pnpm create stdf
 # or
 # or
 npm create stdf@latest
 npm create stdf@latest
@@ -112,5 +116,7 @@ module.exports = {
 4. Start the project.
 4. Start the project.
 
 
 ```sh
 ```sh
+bun dev
+# or
 npm run dev
 npm run dev
 ```
 ```