Update readme for building agent with the android apk (#480)

* doc: update readme for building agent * doc: update zh-cn readme doc * doc: update readme
microsoft · May 16, 2023 · b4f320b · b4f320b
1 parent 5bf8c62
commit b4f320b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,8 @@
 *.tar.gz
 *.rar
 
+*.apk
+
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 

diff --git a/README.md b/README.md
@@ -160,6 +160,14 @@ java -jar center/build/libs/center.jar
 **Step 2. build and run Hydra Lab agent service.**
 
 ```bash
+# In project root
+cd android_client
+# Build the Android client apk
+./gradlew assembleDebug
+cp app/build/outputs/apk/debug/app-debug.apk ../common/src/main/resources/record_release.apk
+# If you don't have the SDK for Android ,you can download the prebuilt APK in https://github.com/microsoft/HydraLab/releases
+# Back to project root
+cd .. 
 # In project root, copy the sample config file and update the:
 # YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID and YOUR_REGISTERED_AGENT_SECRET.
 cp agent/application-sample.yml application.yml

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -129,6 +129,13 @@ java -jar center/build/libs/center.jar
 **第2步. 构建并运行 Hydra Lab agent 服务。**
 
 ```bash
+# 在项目根目录下
+cd android_client
+# 编译Android端APK
+./gradlew assembleDebug
+cp app/build/outputs/apk/debug/app-debug.apk ../common/src/main/resources/record_release.apk
+# 如果没有安装 Android SDK 平台工具，可以在 https://github.com/microsoft/HydraLab/releases 下载已经编译好的 APK 文件。
+# Back to project root
 # 在项目根目录下，复制示例配置文件并更新：
 # YOUR_AGENT_NAME, YOUR_REGISTERED_AGENT_ID 和 YOUR_REGISTERED_AGENT_SECRET 。
 cp agent/application-sample.yml application.yml