From 7eb6fd0be1a4a01879a5290fefb603c1e8033efc Mon Sep 17 00:00:00 2001
From: zhanli <719901725@qq.com>
Date: Tue, 28 Nov 2023 23:44:19 +0800
Subject: [PATCH] update

---
 README.md           |  7 ++++++-
 Workspace/README.md | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 Workspace/README.md

diff --git a/README.md b/README.md
index d5c14c0..aac77eb 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 
 
-# ORB-SLAM3 -UESTC使用说明
+# ORB-SLAM3 -UESTC
+
+概述：基于ORB-SLAM3调整的专用版本。`Workspace`目录下的ORB-SLAM3的核心部分源自
 
 ## 一、基本操作
 
@@ -25,7 +27,10 @@ make
 ​		cam.yaml是摄像头的标定信息。
 
 ```shell
+# 原版
 # 运行可执行程序 mono_euroc_cap 参数0为ORBvoc.txt 参数1为./Examples/Monocular/cam2.yaml 
 ./Examples/Monocular/mono_euroc_cap  ./Vocabulary/ORBvoc.txt  ./Examples/Monocular/cam2.yaml 
+# zhanli整理版
+./Application/mono_euroc_cap  ./Vocabulary/ORBvoc.txt  ./Application/cam2.yaml 
 ```
 
diff --git a/Workspace/README.md b/Workspace/README.md
new file mode 100644
index 0000000..f4d0996
--- /dev/null
+++ b/Workspace/README.md
@@ -0,0 +1,36 @@
+
+
+# ORB-SLAM3 -UESTC使用说明
+
+## 一、基本操作
+
+### 1.1 代码的编译
+
+```shell
+# 如果没有build文件夹则创建build文件夹
+mkdir build
+cd build
+# 该命令会在当前目录的上级目录中查找CMakeLists.txt文件，并使用CMake生成Makefile。CMAKE_BUILD_TYPE指定编译的模式，这里指定为# Release，表示编译优化版本，以提高代码的性能
+cmake .. -DCMAKE_BUILD_TYPE=Release
+# 该命令会使用Makefile编译和构建代码。Makefile是由CMake生成的，它包含了编译和构建代码所需的所有信息。在运行make命令后，它会# # 编译和构建代码，并在当前目录生成可执行文件或库文件
+
+# make -j4 命令用于在Linux或Unix系统上使用多个线程同时编译代码
+make 
+```
+
+### 1.2 代码的运行
+
+​		实际上是执行Examples目录下的mono_euroc_cap程序并提供两个参数信息，分别为ORBvoc.txt和cam2.yaml。
+
+​		ORBvoc是ORB-SLA-M2中使用的词汇表（vocabulary），也称为字典。ORB-SLAM2是一种基于特征点的实时单目SLAM算法，用于在机器人或无人机等设备上进行实时定位和建图。ORBvoc词汇表包含了一组视觉特征点的描述符，用于对图像进行特征点匹配和建图。在ORB-SLAM2中，ORB-voc词汇表用于实现回环检测和重定位，以提高定位和建图的准确性和鲁棒性。ORBvoc词汇表是通过使用一些大规模的数据集（如TUM、KITTI等）进行训练得到的，可以通过下载预训练的ORBvoc词汇表来加速ORB-SLAM2的使用。
+
+​		cam.yaml是摄像头的标定信息。
+
+```shell
+# 原版
+# 运行可执行程序 mono_euroc_cap 参数0为ORBvoc.txt 参数1为./Examples/Monocular/cam2.yaml 
+./Examples/Monocular/mono_euroc_cap  ./Vocabulary/ORBvoc.txt  ./Examples/Monocular/cam2.yaml 
+# zhanli整理版
+./Application/mono_euroc_cap  ./Vocabulary/ORBvoc.txt  ./Application/cam2.yaml 
+```
+