Week 7:Markdown 与 GitHub 作业整理
本周复习 ROS2 编译和运行流程,学习 Markdown 基础,并用期中作业替代考试:整理 GitHub 作业目录,提高可读性。
课堂内容
- 复习。
- Markdown。
- 期中考试(作业替代):整理 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



ROS2 启动复习
运行节点:
ros2 run ros2_kitti_publishers kitti_publishers
格式:
ros2 run 软件包名字 节点名字
也可以使用 launch 文件把多个 ROS2 指令打包:
ros2 launch ros2_kitti_publishers kitti.launch.py

Markdown 基础
Markdown 文件通常以 .md 结尾,例如:
README.md
week7.md
标题语法:在单词或短语前添加井号 #,井号数量代表标题级别。
# 一级标题
## 二级标题
### 三级标题
参考资料:
https://markdown.com.cn/intro.html
https://markdown.com.cn/basic-syntax/

在 Markdown 中嵌入图片
可以使用 HTML 写法控制图片宽度:
<img src="img/img1.png" alt="ros2 小乌龟" width="500">
<img src="img/img2.png" alt="机器狗" width="500">
将 img/img2.png 替换为实际图片相对于 .md 文件的位置。
也可以使用 Markdown 图片语法:


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

期中作业:整理 GitHub 作业目录
要求:
- 必须按照周次设置文件目录,每周都有
README.md。 - 每个周次的
README.md要说明当周做了什么。 - 必须把图片嵌入 Markdown 文件中,可以尝试代码嵌入。
- 作业根目录下的
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