diff options
Diffstat (limited to 'report/README.md')
| -rw-r--r-- | report/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/report/README.md b/report/README.md new file mode 100644 index 0000000..6360eac --- /dev/null +++ b/report/README.md @@ -0,0 +1,46 @@ +# 报告模板通用指南 + +通常我们提供包括但不限于 Markdown 格式的报告模板，以便于大家准确精炼地展示助教想要了解的信息。 + +如果你不使用我们提供的模板，你也需要参考我们提供的模板内容来组织你的报告。 + +无论我们提供何种格式的报告模板，或你自己选择的制作格式，你都需要在提交时同时提交**源文件**和**转换出的 PDF** ，以便于助教查阅。 + +> 比如 .tex 和 .pdf 文件。 + +提交时你的目录结构应该是 + +``` +|- report + |- report.md + |- report.pdf + |- imgs + |- img1.png + |- img2.png +``` + +## 通用报告要求 + +我们有一些跨 lab 共通的报告要求： + +1. 不要贴大段的代码，你可以通过以下手段来避免： + - 使用伪代码 + - 用注释替代一些不重要的部分 + - 如果确实必要，请一小段一小段地复制，并配合文字解释 +2. 如果某段内容很长，请用“总分”的格式来组织，即先分点简述一下，再开始展开。同时，最好先讲你觉得最重要的部分。 +3. 不要写大段“助教知道”的内容，除非助教要求，比如解释非你修改/写的代码的内容。 +4. 尽量精简，不要用 AI 生成工具的车轱辘话来应付报告，我们宁愿你写得很短。 + +## Markdown 转 PDF + +### 方法一：Typora + +https://typora.io/#download + +> 我们可能会于上机课上解释 Typora 的用法。但互联网上的资料已经足够丰富。 + +### 方法二：vscode + Markdown Preview Enhanced 插件 + +> 这个只需在vscode中下载插件即可完成预览和导出操作。 + + |