From 05d2d82236f71be4defd9056a4d19d001e1b8b85 Mon Sep 17 00:00:00 2001
From: hengguo <3527431075@qq.com>
Date: Tue, 23 Sep 2025 16:57:54 +0800
Subject: [PATCH] update readme

---
 unitree_deploy/README.md         | 12 ++++++++++--
 unitree_deploy/docs/README_cn.md | 12 ++++++++++--
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/unitree_deploy/README.md b/unitree_deploy/README.md
index 3770ae1..c0d1ba6 100644
--- a/unitree_deploy/README.md
+++ b/unitree_deploy/README.md
@@ -97,6 +97,9 @@ Perform the following tests to ensure proper functionality:
 
 - **G1 Datasets Replay**:
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1, 
+  
   python test/test_replay.py --repo-id unitreerobotics/G1_CameraPackaging_NewDataset --robot_type g1_dex1
   ```
 ---
@@ -121,8 +124,7 @@ Clone and build the required repositories:
 
 4. Start the Z1 controller [Modify according to your own path]:
     ```bash
-    cd z1_controller/build
-    ./z1_ctrl
+    cd z1_controller/build && ./z1_ctrl
     ```
 
 ---
@@ -148,6 +150,9 @@ Run the following tests:
 
 - **Z1 Datasets Replay**:
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1, 
+
   python test/test_replay.py --repo-id unitreerobotics/Z1_StackBox_Dataset --robot_type z1_realsense
   ```
 ---
@@ -188,6 +193,9 @@ Run the following tests:
 
 - **Z1_Dual Datasets Replay**:
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1, 
+
   python test/test_replay.py --repo-id unitreerobotics/Z1_Dual_Dex1_StackBox_Dataset_V2 --robot_type z1_dual_dex1_realsense
   ```
 ---
diff --git a/unitree_deploy/docs/README_cn.md b/unitree_deploy/docs/README_cn.md
index 58053aa..b826f69 100644
--- a/unitree_deploy/docs/README_cn.md
+++ b/unitree_deploy/docs/README_cn.md
@@ -89,6 +89,9 @@ cd unitree_sdk2_python  && pip install -e . && cd ..
 
 - **G1 数据集回放**：
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1, 
+
   python test/test_replay.py --repo-id unitreerobotics/G1_CameraPackaging_NewDataset --robot_type g1_dex1
   ```
 ---
@@ -113,8 +116,7 @@ cd unitree_sdk2_python  && pip install -e . && cd ..
 
 4. 启动 Z1 控制器 [根据您的路径修改]：
   ```bash
-  cd z1_controller/build
-  ./z1_ctrl
+  cd z1_controller/build && ./z1_ctrl
   ```
 
 ---
@@ -140,6 +142,9 @@ cd unitree_sdk2_python  && pip install -e . && cd ..
 
 - **Z1 数据集回放**：
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1, 
+
   python test/test_replay.py --repo-id unitreerobotics/Z1_StackBox_Dataset --robot_type z1_realsense
   ```
 ---
@@ -180,6 +185,9 @@ cd unitree_sdk2_python  && pip install -e . && cd ..
 
 - **Z1_Dual 数据集回放**：
   ```bash
+  # --repo-id     Your unique repo ID on Hugging Face Hub 
+  # --robot_type     The type of the robot e.g., z1_dual_dex1_realsense, z1_realsense, g1_dex1,
+
   python test/test_replay.py --repo-id unitreerobotics/Z1_Dual_Dex1_StackBox_Dataset_V2 --robot_type z1_dual_dex1_realsense
   ```
 ---