Week 7:Markdown 与 GitHub 作业整理

本周复习 ROS2 编译和运行流程,学习 Markdown 基础,并用期中作业替代考试:整理 GitHub 作业目录,提高可读性。

课堂内容

  1. 复习。
  2. Markdown。
  3. 期中考试(作业替代):整理 GitHub 作业目录,提升可读性。

ROS2 编译复习

进入工作区:

cd ~/ros2_ws

编译 ROS2 软件包:

colcon build --cmake-clean-cache

说明:

  • colcon build 用于编译无法通过 apt 直接安装的软件包。
  • 编译后会生成 build/install/

初始化环境:

source ./install/setup.bash

参考文档:

https://ros2docs.robook.org/humble/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.html

Week 7 复习截图 1

Week 7 复习截图 2

ROS2 colcon 编译命令截图

ROS2 启动复习

运行节点:

ros2 run ros2_kitti_publishers kitti_publishers

格式:

ros2 run 软件包名字 节点名字

也可以使用 launch 文件把多个 ROS2 指令打包:

ros2 launch ros2_kitti_publishers kitti.launch.py

ROS2 run 和 launch 启动方式截图

Markdown 基础

Markdown 文件通常以 .md 结尾,例如:

README.md
week7.md

标题语法:在单词或短语前添加井号 #,井号数量代表标题级别。

# 一级标题
## 二级标题
### 三级标题

参考资料:

https://markdown.com.cn/intro.html
https://markdown.com.cn/basic-syntax/

Markdown 标题语法和参考链接截图

在 Markdown 中嵌入图片

可以使用 HTML 写法控制图片宽度:

<img src="img/img1.png" alt="ros2 小乌龟" width="500">
<img src="img/img2.png" alt="机器狗" width="500">

img/img2.png 替换为实际图片相对于 .md 文件的位置。

也可以使用 Markdown 图片语法:

![ros2 小乌龟](img/img1.png)

Markdown 中嵌入图片示例截图

VS Code 小技巧

建议搜索并切换中文界面。VS Code 可以预览 Markdown 页面,方便检查标题、图片和代码块是否显示正确。

VS Code Markdown 预览按钮截图

期中作业:整理 GitHub 作业目录

要求:

  1. 必须按照周次设置文件目录,每周都有 README.md
  2. 每个周次的 README.md 要说明当周做了什么。
  3. 必须把图片嵌入 Markdown 文件中,可以尝试代码嵌入。
  4. 作业根目录下的 README.md 可以个性化完成。

参考:

https://github.com/ai-robot-class/ros2_kitti_publishers/blob/main/README.md
https://github.com/ai-robot-class/ai-robot-frank/blob/main/README.md

建议目录结构:

ai-robotics-homework/
├── README.md
├── week2/
│   ├── README.md
│   └── img/
├── week3/
│   ├── README.md
│   └── img/
└── week6/
    ├── README.md
    └── img/

提交前检查:

git status
git add .
git commit -m "整理期中作业目录"
git push

results matching ""

    No results matching ""