[doc] update

Robocup-ssl-China · Feb 18, 2024 · d0981b0 · d0981b0
1 parent e574f88
commit d0981b0
Show file tree

Hide file tree

Showing 13 changed files with 23 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # Rocos - **RO**bo**C**up **O**pen **S**ource small size league framework
 
-![Rocos](doc/posts/img/rocos.png)
+![Rocos](doc/img/rocos.png)
 
 > RoboCup小型组开源框架
 
-* [编译](INSTALL.md) （已更新Ubuntu编译指令）
+* [编译](https://rocos.readthedocs.io/zh_CN/latest/posts/1_rocos_basic/1_0.html) （已更新Ubuntu编译指令）
 
-* [更新记录](CHANGELOG.md)
+* [更新记录](https://rocos.readthedocs.io/zh_CN/latest/posts/z/CHANGELOG.html)
 
 * [Wiki](https://rocos.readthedocs.io/zh_CN/latest/index.html)
 

diff --git a/doc/posts/img/chinaopen2022.jpg → doc/img/chinaopen2022.jpg b/doc/posts/img/chinaopen2022.jpg → doc/img/chinaopen2022.jpg
diff --git a/doc/img/client_run.png b/doc/img/client_run.png
diff --git a/doc/posts/img/client_ui.png → doc/img/client_ui.png b/doc/posts/img/client_ui.png → doc/img/client_ui.png
diff --git a/doc/posts/img/client_ui2.png → doc/img/client_ui2.png b/doc/posts/img/client_ui2.png → doc/img/client_ui2.png
diff --git a/doc/posts/img/controller.png → doc/img/controller.png b/doc/posts/img/controller.png → doc/img/controller.png
diff --git a/doc/posts/img/rocos.png → doc/img/rocos.png b/doc/posts/img/rocos.png → doc/img/rocos.png
diff --git a/doc/posts/img/ssl_system.png → doc/img/ssl_system.png b/doc/posts/img/ssl_system.png → doc/img/ssl_system.png
diff --git a/doc/posts/0_introduction/0_1.md b/doc/posts/0_introduction/0_1.md
@@ -6,7 +6,7 @@
 
 让我们从更细致的角度来看Rocos的模块分布：
 
-```{thumbnail} ../img/ssl_system.png
+```{thumbnail} ../../img/ssl_system.png
 ```
 
 上图可以粗略拆分成两部分，左侧虚线框内是官方提供的**辅助软件**，一般只会在比赛时运行负责裁判指令以及可视化等功能。**图右侧**展示了Rocos的模块拆分，图中的每个箭头代表了模块间的通信数据流。为了更清晰的展示架构，图中并没有以软件包或进程的方式进行构建，而是以功能模块的方式进行了拆分，箭头所代表的数据流包含了进程的网络通讯、线程间的内存共享等不同方式。
@@ -24,7 +24,7 @@
 :margin: auto
 :width: 50%
 
-```{thumbnail} ../img/controller.png
+```{thumbnail} ../../img/controller.png
 ```
 :::
 

diff --git a/doc/posts/1_rocos_basic/1_0.md b/doc/posts/1_rocos_basic/1_0.md
@@ -1,4 +1,4 @@
-# 编译&安装
+# 编译&运行
 
 ## 在Ubuntu 22.04下编译Rocos
 * 在安装好系统后，配置源，可以参考[清华源](https://mirrors.tuna.tsinghua.edu.cn/help/ubuntu/)，选择对应版本后更改**软件源配置文件**`/etc/apt/sources.list`。
@@ -42,6 +42,19 @@ git checkout dev
 dev分支可能会有一些测试不够完备的功能，如果在使用中有任何问题，欢迎给Rocos[提交issue](https://github.com/Robocup-ssl-China/rocos/issues/new)或者PR。
 ```
 
+## 运行Rocos
+
+在终端下进入`ZBin`文件夹，启动Client软件，点击`Vision`内的连接按钮，敲击键盘的快捷键`1`和`Ctrl+1`，再点击带有蓝色字`LEFT → RIGHT`的启动按钮可以看到机器人在运动。
+```bash
+# 假设在build文件夹下编译通过，先进入ZBin文件夹
+cd ../ZBin
+# 启动Client
+./Client
+```
+
+```{thumbnail} ../../img/client_run.png
+```
+
 ## 参考资料：
 * [清华源](https://mirrors.tuna.tsinghua.edu.cn/help/ubuntu/)
 * [廖雪峰的git教程](https://www.liaoxuefeng.com/wiki/896043488029600)
diff --git a/doc/posts/1_rocos_basic/1_1.md b/doc/posts/1_rocos_basic/1_1.md
@@ -4,12 +4,12 @@
 
 ## 软件界面
 
-```{thumbnail} ../img/client_ui.png
+```{thumbnail} ../../img/client_ui.png
 ```
 
 在编译完成后，通过终端或qt-creator打开Client软件，会呈现一个灰色的界面。界面中心是一个场地主画布，用于显示场地图像信息以及调试信息。右侧为操作边栏，分别为主操作栏、裁判盒模拟、LOG回放、参数设置。
 
-```{thumbnail} ../img/client_ui2.png
+```{thumbnail} ../../img/client_ui2.png
 ```
 
 ### 场地画布

diff --git a/doc/posts/z/CHANGELOG.md b/doc/posts/z/CHANGELOG.md
@@ -36,5 +36,5 @@
 - 连接远程仿真环境流程
   - 选择仿真环境所在服务器的IP
     - 127.0.0.1为本地仿真不支持联机 \
-    ![image](../img/chinaopen2022.jpg){w=600px}
+    ![image](../../img/chinaopen2022.jpg){w=600px}
   - 根据实际比赛情况在AlertPort/vision4Remote里更改接收仿真图像的端口
diff --git a/INSTALL.md → doc/posts/z/OLD_INSTALL.md b/INSTALL.md → doc/posts/z/OLD_INSTALL.md
@@ -1,19 +1,4 @@
-# 编译使用教程
-
-## Ubuntu22.04 Compile
-* install deps
-```bash
-sudo apt install git cmake build-essential libgl1-mesa-dev libode-dev qtbase5-dev qtdeclarative5-dev libqt5serialport5-dev libtolua++5.1-dev libeigen3-dev protobuf-compiler libprotobuf-dev qml-module-qtquick* qml-module-qtgamepad libfmt-dev
-```
-* clone and build
-```bash
-git clone https://github.com/Robocup-ssl-China/rocos.git
-cd rocos
-mkdir -p build
-cd build
-cmake ..
-cmake --build . --config Release --parallel `nproc`
-```
+# 旧版本编译操作
 
 ## Windows VS2015-64bit Client与Sim编译