chore(doc): updated README

Cyunong · Jan 20, 2021 · 9b967b9 · 9b967b9
1 parent c1552d5
commit 9b967b9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/PUBLISH.zh_CN.md b/PUBLISH.zh_CN.md
@@ -38,11 +38,12 @@ git tag -d [VERSION]
 iOS
 
 * [hippy.podspec](https://github.com/Tencent/Hippy/blob/master/hippy.podspec#L11)
-* [HippyBridge.mm](https://github.com/Tencent/Hippy/blob/master/ios/sdk/base/HippyBridge.mm#L43)
+* [HippyBridge.mm](https://github.com/Tencent/Hippy/blob/master/ios/sdk/base/HippyBridge.mm#L45)
 
 Android
 
-* [build.gradle](https://github.com/Tencent/Hippy/blob/master/android/sdk/build.gradle#L518)
+* [build.gradle](https://github.com/Tencent/Hippy/blob/master/android/sdk/bintrayUpload.gradle#L8)
+* 取消 `def artifactIdDefined = "hippy-release"` 的注释，同时注释掉 `def artifactIdDefined  = "hippy-snapshot"`
 
 ## 4. 更新内置包并校验功能正常
 
@@ -126,4 +127,4 @@ git push --tags # 提交 tag
   > 如果发布时参数检查失败，可以在`pod`命令前面加上 `COCOAPODS_VALIDATOR_SKIP_XCODEBUILD=1` 参数
 
 * Android 发布到 [bintray](https://bintray.com/beta/#/hippy/Hippy/hippy-release?tab=overview)
- 在 Android Studio 中打开 `examples/android-demo` 项目，在`local.properties`添加`bintrayUser=[user]`和`bintrayKey=[key]`，其中`[user]`和`[key]` 分别对应用户在bintray的 `账号名`和 `API key` ，添加完后字旁边的 Gradle 面板中运行 `android-demo` > `android-sdk` > `publishing` > `:android-sdk:bintrayUpload` 即可发布。
+ 在 Android Studio 中打开 `examples/android-demo` 项目，在`local.properties`添加`bintrayUser=[user]`和`bintrayKey=[key]`，其中`[user]`和`[key]` 分别对应用户在bintray的 `账号名`和 `API key` ，添加完后，执行 Android Studio > `build` > `Clean Project`, 再在Gradle 面板中运行 `android-demo` > `android-sdk` > `Tasks` > `other` > `:android-sdk:assembleRelease` , 最后运行 `android-demo` > `android-sdk` > `Tasks` > `publishing` > `:android-sdk:bintrayUpload` 即可发布。
diff --git a/README.md b/README.md
@@ -77,7 +77,9 @@ For iOS we recommend to use iOS simulator when first try, however, you may chang
 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
+6. `cd` to `examples` hippy-react-demo or hippy-vue-demo, run `npm run hippy:dev` and `npm run hippy:debug` respectively to start the live debug mode
+
+On example debug mode, npm packages such as @hippy/react, @hippy/vue are linked to `packages` > `[different package]` >`dist`, so if you have changed package source code and make it take effect in examples, please call `npm run build` at root directory again.
 
 ### Start the android app with hippy-react or hippy-vue demo
 
@@ -94,6 +96,8 @@ Before build the android app, please make sure the SDK and NDK is installed, And
 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.
 
+On example debug mode, npm packages such as @hippy/react, @hippy/vue are linked to `packages` > `[different package]` >`dist`, so if you have changed package source code and make it take effect in examples, please call `npm run build` at root directory again.
+
 > 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).
 
 ## Contribution

diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -79,6 +79,8 @@ Windows 用户需要以下软件:
 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 模式。
 
+在 example 调试模式下，@hippy/react、@hippy/vue等的npm模块会直接链接到 `packages` > `[different package]` >`dist` 下面，所以如果你修改了package下的源代码并且想让其在example中生效，请重新在根目录执行 `npm run build`。
+
 ### 启动 Android App 来测试 hippy-react 或者 hippy-vue 范例
 
 我们推荐 Android 开发者使用真机，因为 Hippy 使用的 [X5](https://x5.tencent.com/) JS 引擎没有提供 x86 的库以至于无法支持 x86 模拟器，但是使用 ARM 模拟器又很慢。
@@ -94,6 +96,8 @@ Windows 用户需要以下软件:
 7. 运行工程，并安装 apk。
 8. cd 到 hippy-react-demo 或者 hippy-vue-demo 目录，分别执行 `npm run hippy:dev` 和 `npm run hippy:debug`, 即开启实时 Debug 模式。
 
+在 example 调试模式下，@hippy/react、@hippy/vue等的npm模块会直接链接到 `packages` > `[different package]` >`dist` 下面，所以如果你修改了package下的源代码并且想让其在example中生效，请重新在根目录执行 `npm run build`。
+
 > 如果 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)。
 
 ## 贡献