chore(doc): change README bootstrap process

Cyunong · Dec 28, 2020 · 5d43b5c · 5d43b5c
1 parent 922fef2
commit 5d43b5c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -73,9 +73,11 @@ For Windows developers:
 For iOS we recommend to use iOS simulator when first try, however, you may change the Xcode configuration to install the app to iPhone if you are an iOS expert.
 
 1. Install the dependencies with `npm install`.
-2. Build the front-end sdk packages with `npm run build`.
-3. Choose a demo to build with `npm run buildexample -- [hippy-react-demo|hippy-vue-demo]`.
-4. Start the Xcode and build the iOS app with `open examples/ios-demo/HippyDemo.xcodeproj`.
+2. Install dependencies of each npm package with `lerna bootstrap`.
+3. Build the front-end sdk packages at root directory with `npm run build`.
+4. Choose a demo to build with `npm run buildexample -- [hippy-react-demo|hippy-vue-demo]`.
+5. Start the Xcode and build the iOS app with `open examples/ios-demo/HippyDemo.xcodeproj`.
+6. `cd` to hippy-react-demo or hippy-vue-demo, run `npm run hippy:dev` and `npm run hippy:debug` respectively to start the live debug mode
 
 ### Start the android app with hippy-react or hippy-vue demo
 
@@ -84,11 +86,13 @@ For Android we recommend to use the real cellphone for better experience, becaus
 Before build the android app, please make sure the SDK and NDK is installed, And *DO NOT* update the build toolchain.
 
 1. Install the dependencies with `npm install`.
-2. Build the front-end sdk packages with `npm run build`.
-3. Open a terminal, then build the hippy-react demo with `npm run buildexample -- hippy-react-demo`, or build the hippy-vue demo with `npm run buildexample -- hippy-vue-demo` .
-4. Open the `examples/android-demo` with Android Studio.
-5. Connect android phone with USB cable and make sure USB debugging mode and USB installation are enabled.
-6. Open the project with Android Studio, run and install the apk.
+2. Install dependencies of each npm package with `lerna bootstrap`.
+3. Build the front-end sdk packages at root directory with `npm run build`.
+4. Open a terminal, then build the hippy-react demo with `npm run buildexample -- hippy-react-demo`, or build the hippy-vue demo with `npm run buildexample -- hippy-vue-demo` .
+5. Open the `examples/android-demo` with Android Studio.
+6. Connect android phone with USB cable and make sure USB debugging mode and USB installation are enabled.
+7. Open the project with Android Studio, run and install the apk.
+8. `cd` to hippy-react-demo or hippy-vue-demo, run `npm run hippy:dev` and `npm run hippy:debug` respectively to start the live debug mode.
 
 > If you encounter the issue of `No toolchains found in the NDK toolchains folder for ABI with prefix: mips64el-linux-android`, here is the [solution](https://github.com/google/filament/issues/15#issuecomment-415423557).
 

diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -72,10 +72,12 @@ Windows 用户需要以下软件:
 
 我们推荐 iOS 开发者使用模拟器来进行开发和调试工作，当然如果你是一个 iOS 开发高手，也可以通过修改配置将 Hippy app 安装到手机上。
 
-1. 安装前端依赖，运行命令：`npm install`。
-2. 编译前端 SDK 包，运行命令： `npm run build`。
-3. 选择一个前端范例项目来进行编译：`npm run buildexample -- [hippy-react-demo|hippy-vue-demo]`。
-4. 启动 Xcode 并且开始编译终端 App：`open examples/ios-demo/HippyDemo.xcodeproj`。
+1. 安装前端依赖，根目录运行命令：`npm install`。
+2. 通过 lerna 安装前端每一个package依赖: `lerna bootstrap`。
+3. 编译前端 SDK 包，根目录运行命令： `npm run build`。
+4. 选择一个前端范例项目来进行编译：`npm run buildexample -- [hippy-react-demo|hippy-vue-demo]`。
+5. 启动 Xcode 并且开始编译终端 App：`open examples/ios-demo/HippyDemo.xcodeproj`。
+6. cd 到 hippy-react-demo 或者 hippy-vue-demo 目录，分别执行 `npm run hippy:dev` 和 `npm run hippy:debug`, 即开启实时 Debug 模式。
 
 ### 启动 Android App 来测试 hippy-react 或者 hippy-vue 范例
 
@@ -84,11 +86,13 @@ Windows 用户需要以下软件:
 在开始前请确认好 SDK 和 NDK 都安装了范例的指定版本，并且**请勿**更新编译工具链。
 
 1. 安装前端依赖，运行命令：`npm install`。
-2. 编译前端 SDK 包，运行命令： `npm run build`。
-3. 打开一个命令行程序，并选择 hippy-react 范例项目进行编译：`npm run buildexample hippy-react-demo`，或者编译 hippy-vue 范例项目 `npm run buildexample hippy-vue-demo`。
-4. 用 Android Studio 来打开终端范例工程 `examples/android-demo`。
-5. 用 USB 数据线插上你的 Android 手机，需要确认手机打开 USB 调试模式和 USB 安装。
-6. 运行工程，并安装 apk。
+2. 通过 lerna 安装前端每一个 package 依赖: `lerna bootstrap`。
+3. 编译前端 SDK 包，根目录运行命令： `npm run build`。
+4. 打开一个命令行程序，并选择 hippy-react 范例项目进行编译：`npm run buildexample hippy-react-demo`，或者编译 hippy-vue 范例项目 `npm run buildexample hippy-vue-demo`。
+5. 用 Android Studio 来打开终端范例工程 `examples/android-demo`。
+6. 用 USB 数据线插上你的 Android 手机，需要确认手机打开 USB 调试模式和 USB 安装。
+7. 运行工程，并安装 apk。
+8. cd 到 hippy-react-demo 或者 hippy-vue-demo 目录，分别执行 `npm run hippy:dev` 和 `npm run hippy:debug`, 即开启实时 Debug 模式。
 
 > 如果 Android Studio 报了这个错误 `No toolchains found in the NDK toolchains folder for ABI with prefix: mips64el-linux-android`，这里有[解决办法](https://github.com/google/filament/issues/15#issuecomment-415423557)。