Skip to content

docs: resync translated READMEs with English source, add sync check #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZhuYaoHui1998 merged 2 commits into from
Aug 22, 2026
Merged

docs: resync translated READMEs with English source, add sync check #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c26afc6
docs: point RS BOM links at README.md, not readme.md
Aug 20, 2026
a5d9092
docs: resync translated READMEs with the English source
Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/workflows/readme-sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Check README Translations

on:
pull_request:
paths:
- "README*.md"
- "tools/check_readme_sync.py"
- "tools/tests/**"
- ".github/workflows/readme-sync.yml"

workflow_dispatch:


permissions:
contents: read


concurrency:
group: readme-sync-${{ github.ref }}
cancel-in-progress: true


jobs:
readme-sync:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: "3.12"

# Compares the translations against README.md on roadmap row counts,
# per-row status, and specification numbers. Prose is never compared.
- name: Check translations against README.md
run: python tools/check_readme_sync.py

- name: Test the checker itself
run: python -m unittest discover -s tools/tests -v
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Python bytecode from tools/
__pycache__/
*.py[cod]
4 changes: 2 additions & 2 deletions README_Fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,14 +156,14 @@ Nous nous engageons à maintenir et à adapter en continu les principaux écosys
| Écosystème pris en charge | Statut | Description / Date de sortie estimée | Documentation associée |
| :------------------------------------------------------------------------------------- | :-------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Utilisation de base des moteurs** | ✅ Terminé | Contrôle de mouvement de base et encapsulation des API | [Robstride](https://wiki.seeedstudio.com/cn/robstride_control/) |
| **Publication en open source des nouvelles pièces structurelles 3D STEP et de la BOM** | ✅ Terminé | Fichiers STEP de toutes les pièces de la nouvelle version, nomenclature des pièces (BOM) et prix de référence pour tous les composants usinés | [BOM reBot Arm B601-RS](./hardware/reBot_B601_RS/readme.md) |
| **Publication en open source des nouvelles pièces structurelles 3D STEP et de la BOM** | ✅ Terminé | Fichiers STEP de toutes les pièces de la nouvelle version, nomenclature des pièces (BOM) et prix de référence pour tous les composants usinés | [BOM reBot Arm B601-RS](./hardware/reBot_B601_RS/README.md) |
| **Prise en main (Getting Started)** | ✅ Terminé | Guide de démarrage rapide du B601-RS | [Getting Started with reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **Vidéo d’assemblage** | ✅ Terminé | Étapes d’assemblage ultra détaillées avec vidéo explicative | [Vidéo d’assemblage reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **ROS2 (Humble)** | ✅ Terminé | Contrôleur reBot Arm intégré à ROS2 avec prise en charge de la cinématique, de la planification de trajectoire, de la compensation de gravité et de MoveIt2 | [Guide d’intégration ROS2 du reBot Arm B601-DM](https://wiki.seeedstudio.com/rebot_arm_b601_rs_ros2_integration/) |
| **Intégration LeRobot** | ✅ Terminé | Adaptation au framework d’entraînement Hugging Face LeRobot | [Guide de démarrage avec LeRobot pour le reBot Arm](https://wiki.seeedstudio.com/rebot_arm_b601_rs_lerobot/) |
| **Intégration Pinocchio** | ✅ Terminé | Adaptation au framework Pinocchio permettant la cinématique directe, la cinématique inverse et la compensation de gravité du bras robotique | [Guide de démarrage Pinocchio pour reBot Arm B601-DM](https://wiki.seeedstudio.com/rebot_arm_b601_rs_pinocchio_meshcat/) et [Dépôt Github](https://github.com/vectorBH6/reBotArm_control_py) |
| **Intégration caméra de profondeur** | ✅ Terminé | Démonstration de préhension visuelle basée sur YOLO et une caméra de profondeur | [Guide de démarrage de la démonstration de préhension visuelle](https://wiki.seeedstudio.com/rebot_arm_b601_dm_grasping_demo/) |
| **Simulation Isaac Sim** | ⏳ Prévu | Importation des modèles USD et activation de la téléopération simulée | [Dépôt Github](https://github.com/Seeed-Projects/reBot-Isaacsim) |
| **Simulation Isaac Sim** | ✅ Terminé | Importation des modèles USD et activation de la téléopération simulée | [Dépôt Github](https://github.com/Seeed-Projects/reBot-Isaacsim) |
| **Mises à jour progressives des derniers algorithmes** | ⏳ Prévu | Les algorithmes couramment utilisés dans l’industrie seront progressivement intégrés | En cours |
| **Lancement d’une série de cours entièrement gratuits** | ⏳ Prévu | Des cours gratuits couvrant les principaux algorithmes seront progressivement publiés | En cours |

Expand Down
28 changes: 15 additions & 13 deletions README_JP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,19 +152,21 @@
| :--- | :---: | :--- | :--- |
| **ROS2 (Humble), third_party 統合, URDF / rebotarm_bringup** | [@danieldoradotalaveron-rb](https://github.com/danieldoradotalaveron-rb) | 1. **パッシブ診断モニター** (`rebotarm_monitor_ros2`): `rqt_robot_monitor` 向け `/diagnostics` オーバーレイ、serial/CAN 対応アグリゲーター;<br>2. **安全な退避とシャットダウン**: 接続時に休止姿勢を取得し、シャットダウンまたは `/rebotarm/park` 時にゆっくり戻して急落を防止;<br>3. **重力補償 (スムーズ停止)**: 重力補償終了時に MIT ランプアウトを行い、pos/vel 引き継ぎ時の衝撃、急動作、不安定性を低減;<br>4. **IK/FK と安全対策を備えたゲームパッドテレオペ**: IK によるエンドエフェクタ制御、RViz でのロボット状態のライブ可視化 (シミュレーションのみでテスト);<br>5. **D405 eye-in-hand TF**: `rebotarm_bringup` の `end_link` 下に Xacro 設定を追加し、RViz 可視化と TF のみに使用 (driver/depth/intrinsics なし)。取付姿勢は launch ファイルで調整可能、ブラケットキャリブレーションは未完了。Teleop FK/IK はアームのみの `fixend_core` URDF を使用し、RSP/RViz には完全な xacro を使用。 | [rebotarm_monitor_ros2](https://github.com/danieldoradotalaveron-rb/rebotarm_monitor_ros2)、[reBotArmController_ROS2](https://github.com/danieldoradotalaveron-rb/reBotArmController_ROS2) |

| Écosystème pris en charge | Statut | Description / Date de sortie estimée | Documentation associée |
| :------------------------------------------------------------------------------------- | :-------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Utilisation de base des moteurs** | ✅ Terminé | Contrôle de mouvement de base et encapsulation des API | [Robstride](https://wiki.seeedstudio.com/cn/robstride_control/) |
| **Publication en open source des nouvelles pièces structurelles 3D STEP et de la BOM** | ✅ Terminé | Fichiers STEP de toutes les pièces de la nouvelle version, nomenclature des pièces (BOM) et prix de référence pour tous les composants usinés | [BOM reBot Arm B601-RS](./hardware/reBot_B601_RS/readme.md) |
| **Prise en main (Getting Started)** | ✅ Terminé | Guide de démarrage rapide du B601-RS | [Getting Started with reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **Vidéo d’assemblage** | ✅ Terminé | Étapes d’assemblage ultra détaillées avec vidéo explicative | [Vidéo d’assemblage reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **ROS2 (Humble)** | ✅ Terminé | Contrôleur reBot Arm intégré à ROS2 avec prise en charge de la cinématique, de la planification de trajectoire, de la compensation de gravité et de MoveIt2 | [Guide d’intégration ROS2 du reBot Arm B601-DM](https://wiki.seeedstudio.com/rebot_arm_b601_rs_ros2_integration/) |
| **Intégration LeRobot** | ✅ Terminé | Adaptation au framework d’entraînement Hugging Face LeRobot | [Guide de démarrage avec LeRobot pour le reBot Arm](https://wiki.seeedstudio.com/rebot_arm_b601_rs_lerobot/) |
| **Intégration Pinocchio** | ✅ Terminé | Adaptation au framework Pinocchio permettant la cinématique directe, la cinématique inverse et la compensation de gravité du bras robotique | [Guide de démarrage Pinocchio pour reBot Arm B601-DM](https://wiki.seeedstudio.com/rebot_arm_b601_rs_pinocchio_meshcat/) et [Dépôt Github](https://github.com/vectorBH6/reBotArm_control_py) |
| **Intégration caméra de profondeur** | ✅ Terminé | Démonstration de préhension visuelle basée sur YOLO et une caméra de profondeur | [Guide de démarrage de la démonstration de préhension visuelle](https://wiki.seeedstudio.com/rebot_arm_b601_dm_grasping_demo/) |
| **Simulation Isaac Sim** | ⏳ Prévu | Importation des modèles USD et activation de la téléopération simulée | [Dépôt Github](https://github.com/Seeed-Projects/reBot-Isaacsim) |
| **Mises à jour progressives des derniers algorithmes** | ⏳ Prévu | Les algorithmes couramment utilisés dans l’industrie seront progressivement intégrés | En cours |
| **Lancement d’une série de cours entièrement gratuits** | ⏳ Prévu | Des cours gratuits couvrant les principaux algorithmes seront progressivement publiés | En cours |
### reBot Arm B601 RS

| 対応エコシステム | 状態 | 説明 / 予定公開日 | 関連ドキュメント |
| :--- | :---: | :--- | :--- |
| **モーター基本使用** | ✅ 完了 | 基本的なモーション制御と API ラッパー化 | [Robstride](https://wiki.seeedstudio.com/cn/robstride_control/) |
| **新バージョン STEP 3D 構造部品および BOM のオープンソース化** | ✅ 完了 | 新バージョンの全パーツの STEP ファイル、部品 BOM、およびすべての機械加工部品の参考価格 | [reBot Arm B601-RS BOM](./hardware/reBot_B601_RS/README.md) |
| **クイックスタート** | ✅ 完了 | B601-RS のクイックスタート | [Getting Started with reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **組み立て動画** | ✅ 完了 | 超詳細な組み立て手順と動画 | [reBot Arm B601-RS Assembly Video](https://wiki.seeedstudio.com/rebot_b601_rs_getting_started/) |
| **ROS2 (Humble)** | ✅ 完了 | 運動学、軌道計画、重力補償および MoveIt2 に対応した ROS2 統合 reBot Arm コントローラー | [reBot Arm B601-RS ROS2 Integration Guide](https://wiki.seeedstudio.com/rebot_arm_b601_rs_ros2_integration/) |
| **LeRobot 統合** | ✅ 完了 | Hugging Face LeRobot トレーニングフレームワークへの対応 | [Getting Started with LeRobot-based reBot Arm](https://wiki.seeedstudio.com/rebot_arm_b601_rs_lerobot/) |
| **Pinocchio 統合** | ✅ 完了 | Pinocchio フレームワークへの対応により、ロボットアームの順運動学/逆運動学および重力補償を実現 | [Getting Started with Pinocchio for reBot Arm B601-RS](https://wiki.seeedstudio.com/rebot_arm_b601_rs_pinocchio_meshcat/) と [Github repo](https://github.com/vectorBH6/reBotArm_control_py) |
| **深度カメラ統合** | ✅ 完了 | YOLO と深度カメラに基づくビジュアル把持デモ | [Getting Started with Visual Grasping Demo](https://wiki.seeedstudio.com/rebot_arm_b601_dm_grasping_demo/) |
| **Isaac Sim シミュレーション** | ✅ 完了 | USD モデルをインポートし、シミュレーションによる遠隔操作を実現 | [Github Repo](https://github.com/Seeed-Projects/reBot-Isaacsim) |
| **最新アルゴリズムの段階的更新** | ⏳ 計画中 | 主流アルゴリズムを段階的に更新予定 | Ongoing |
| **完全無料コースシリーズの提供** | ⏳ 計画中 | 主流アルゴリズムを段階的に更新予定 | Ongoing |


---
Expand Down
Loading
Loading