Skip to content

Commit 398a7c1

Browse files
committed
docs: update readme
1 parent cee4474 commit 398a7c1

1 file changed

Lines changed: 47 additions & 5 deletions

File tree

README.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,31 @@
99
## 概述
1010
LinkerHand-CPP-ROS2 是灵心巧手科技有限公司开发,基于 LinkerHand-CPP-SDK 的ROS2封装版本。
1111

12-
#### 环境安装
13-
[LinkerHand-CPP-SDK](https://github.com/linker-bot/linkerhand-cpp-sdk.git)
1412

15-
#### 工程编译
13+
## 📋 目录
14+
15+
- [环境要求](#-环境要求)
16+
- [快速开始](#-快速开始)
17+
- [话题详情](#-话题详情)
18+
- [使用示例](#-使用示例)
19+
- [许可证](#-许可证)
20+
- [联系我们](#-联系我们)
21+
- [更新日志](#-更新日志)
22+
23+
## 💻 环境要求
24+
25+
- **操作系统**: Linux (Ubuntu 20.04+ 推荐)
26+
- **架构**: x86_64
27+
- **编译器**: GCC 7.0+ 或 Clang 5.0+
28+
- **CMake**: 3.15+
29+
- **依赖**: ROS2 (推荐 Foxy 或 Humble)、[linkerhand-cpp-sdk](https://github.com/linker-bot/linkerhand-cpp-sdk.git)
30+
31+
32+
## 🚀 快速开始
33+
#### 下载
34+
git clone https://github.com/linker-bot/linkerhand-cpp-ros2.git
35+
36+
#### 编译
1637
cd linkerhand-cpp-ros2/
1738
colcon build
1839

@@ -50,7 +71,7 @@ LinkerHand-CPP-ROS2 是灵心巧手科技有限公司开发,基于 LinkerHand-
5071
ros2 launch linkerhand_cpp_ros2 run.xml
5172

5273

53-
#### 话题
74+
## 📚 话题详情
5475

5576
| 话题名称 | I/O | 消息类型 | 描述 |
5677
| :--- | :--- | :--- | :--- |
@@ -172,7 +193,7 @@ data:
172193
- '...'
173194
```
174195

175-
## 示例
196+
## 💡 使用示例
176197

177198
| 序号 | 文件名称 | 描述 |
178199
| :--- | :-------- | :--------------------------------------------- |
@@ -185,3 +206,24 @@ data:
185206
| 7 | src/examples/src/show_wave_l20 | L20型号wave手势示例 |
186207
| 8 | src/examples/src/action_group_show_l25 | L25型号手指舞示例 |
187208
| 9 | src/examples/src/loop_l25 | L25型号手势张开握拳示例 |
209+
210+
211+
## 📄 许可证
212+
213+
本项目采用 [Apache 2.0 许可证](LICENSE)
214+
215+
Copyright (c) 2026 灵心巧手(北京)科技有限公司
216+
217+
## 📞 联系我们
218+
219+
- **官方网站**: [https://linkerbot.cn](https://linkerbot.cn)
220+
- **关于我们**: [https://linkerbot.cn/aboutUs](https://linkerbot.cn/aboutUs)
221+
- **GitHub**: [https://github.com/linker-bot/linkerhand-cpp-sdk](https://github.com/linker-bot/linkerhand-cpp-sdk)
222+
223+
## 📝 更新日志
224+
225+
详细的版本更新记录请参考 [CHANGELOG.md](CHANGELOG.md)(待创建)。
226+
227+
---
228+
229+
**注意**: 使用前请确保设备已正确连接并配置好通信接口。

0 commit comments

Comments
 (0)