Week 7:Markdown 与 GitHub 作业整理
本周的目标是把前几周分散的实验记录整理成一个可以被 GitHub Pages 浏览、也可以被自动评价系统识别的作业仓库。重点不只是“写一个 README”,而是理解一个课程作业仓库应该具备的基本结构:根目录有总说明,每周文件夹有独立说明,图片使用相对路径引用,代码和截图都放在能被浏览器访问到的位置。
本周完成内容
- 整理仓库目录,把每一周的实验资料放入
Week2、Week3等独立文件夹。 - 为每个周次保留
README.md,说明本周任务、实验步骤、运行结果和学习总结。 - 学习 Markdown 常用语法,包括标题、列表、代码块、表格、链接和图片引用。
- 检查图片路径,优先使用本地相对路径,例如
img7-1.png,避免网页部署后图片无法加载。 - 补充
week7_markdown_check.py,用于统计 README 字符数、标题数、图片数和链接数。
Markdown 记录规范
一个清楚的作业 README 应该至少包含以下几部分:
- 本周主题:说明课程学习目标。
- 实验环境:写清楚使用 WSL、Ubuntu、ROS2、Docker 或 Python 的版本。
- 操作步骤:按顺序记录命令和关键配置。
- 运行截图:嵌入实验结果图片,证明任务已经完成。
- 代码说明:如果有脚本,说明脚本作用和运行方式。
- 总结反思:记录遇到的问题、解决方法和后续可以改进的地方。
代码文件
本周补充了一个小工具脚本:
python3 week7_markdown_check.py
它会读取当前目录的 README.md,输出字符数、标题数量、图片数量和链接数量。这个脚本对应课程自动评价系统关注的几个点:README 是否存在、内容是否足够详细、是否包含图片,以及是否包含可检查的代码文件。
学习总结
通过本周整理,我理解到课程作业不是只把文件“放上去”就结束,还需要让老师、同学和自动化脚本都能快速看懂。README 的标题要清楚,图片路径要稳定,代码文件要放在正确目录,文件名也要尽量使用英文或简单数字,减少 GitHub Pages 部署时的路径问题。后续每周作业都会延续这个结构,保证仓库整体可读、可运行、可展示。