doc: 添加说明文档

README.md

@@ -1,10 +1,46 @@
-# ORB-SLAM3 超详细注释
+# ORB-SLAM3 ROS 使用说明
 
-![DEMO](https://github.com/electech6/ORB_SLAM3_detailed_comments/blob/master/demo.gif)
+## 1. 编译依赖包
 
-独家视频课程《VIO灭霸：ORB-SLAM3公式推导+源码逐行解析+算法改进》！ [点击进入官网](https://cvlife.net/)
+摄像头图像数据依赖于cv_camera获取，因此需要先编译cv_camera包。
 
-点击进入 [小六的机器人SLAM学习圈](https://mp.weixin.qq.com/s?__biz=MzIxOTczOTM4NA==&mid=2247567299&idx=1&sn=2d6b673b6d5e396bd87ec2a28cd3d27d&chksm=97d52254a0a2ab42ff833b5fa733f2213a1ad1ec8ebdb199d96c237aa4cb21fe8e05cc77db8a#rd)，4500+人都在这里交流！
+```bash
+  cd ~/catkin_ws/src/driver/camera/cv_camera
+  catkin build --this
+```
+
+## 2. 编译ORB-SLAM3
+
+编译ORB_SLAM3的Ros包
+
+```bash
+  cd ~/catkin_ws/src/ORB_SLAM3/ROS/orb_slam3
+  catkin build --this
+```
+
+## 3. 修改launch文件
+
+根据摄像头路径修改launch文件，使用ls /dev/v4l/by-path查询摄像头路径。
+
+```xml
+<node pkg="cv_camera" type="cv_camera_node" name="camera" output="screen">
+  <param name="device_path" default="/dev/v4l/by-path/pci-0000:00:14.0-usb-0:1:1.0-video-index0"/>
+</node>
+```
+
+## 4.启动ORB-SLAM3
+
+```bash
+  roslaunch orb_slam3 orb_slam3.launch
+```
+
+## 5.其他
+
+- 当前采用的摄像头分辨率为1280*720
+  - 如果要修改分辨率，需要将cv_camera的参数和launch文件中的参数修改为相应的分辨率。
+  - 还需要修改config文件夹中的相机内参文件，根据标定数据来修改。
+  - 相机标定可采用camera_calibration包进行标定。
+- 当前编译的是Mono版本，即单目摄像头，如果需要其他传感器，参考ros_mono.cc文件修改
 
 ----
 # ORB-SLAM3