From 88be9778c3c5d4650ca1150c89b5e57444328a4c Mon Sep 17 00:00:00 2001 From: Yu Chen Date: Tue, 28 Jun 2022 13:26:22 +0800 Subject: [PATCH] add github classroom info --- README.md | 25 +++++++++++++++---------- guide/source/chapter1/0intro.rst | 20 ++++++++++++++++++++ 2 files changed, 35 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7007bb7..a0e14ac 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,28 @@ Welcome to OS Tutorial Summer of Code 2022（2022年开源操作系统训练营 - [OS Course Slides in 2022 spring](https://learningos.github.io/os-lectures/)(2022春季OS课程Slides) First, you can read [Guide](https://learningos.github.io/rust-based-os-comp2022/) to: - -- setup development environment. -- analyze and try os in ch1 and ch2. +- (Important) `git clone` this repo. +- (Important) setup development environment. +- (Important) setup classroom CI by `make setupclassroom` (if you using githubclassroom to devel labs) +- analyze and try os1 and os2 labs. +- (Option) you can [use github classroom&code space to develop all os labs](https://learningos.github.io/rust-based-os-comp2022/chapter1/0intro.html#id4) just in a net browser. ## os reference framework -The 'os[1-8]-ref' are the 'os[1-8]' reference framework. You can read and copy some codes into os[1-8] +The 'os[1-8]-ref' are the 'os[1-8]' reference frameworks. You can read and copy some codes into os[1-8] ## kernel labs -There are five kernel labs. +There are two simple practice work, and five kernel labs. According to the [Guide](https://learningos.github.io/rust-based-os-comp2022/), write os codes for: -- lab1 in 'os3' DIR -- lab2 in 'os4' DIR -- lab3 in 'os5' DIR -- lab4 in 'os6' DIR -- lab5 in 'os8' DIR +- [lab0-0 setup env in 'os1' DIR](https://classroom.github.com/a/hnoWuKGF) +- [lab0-1 try something in os2 in 'os2' DIR](https://classroom.github.com/a/UEOvz4qO) +- [lab1 in 'os3' DIR](https://classroom.github.com/a/s1v7GyJM) +- [lab2 in 'os4' DIR](https://classroom.github.com/a/ghbB1wYX) +- [lab3 in 'os5' DIR](https://classroom.github.com/a/RxB6h4-x) +- [lab4 in 'os6' DIR](https://classroom.github.com/a/94eMW8zi) +- [lab5 in 'os8' DIR](https://classroom.github.com/a/zqGJEPK-) + ## Check your results - lab1: `make test3` for lab1 diff --git a/guide/source/chapter1/0intro.rst b/guide/source/chapter1/0intro.rst index a34bcdd..10c15d5 100644 --- a/guide/source/chapter1/0intro.rst +++ b/guide/source/chapter1/0intro.rst @@ -37,6 +37,23 @@ 实践体验 --------------------------- +.. note:: + + 基于github classroom的开发方式 + + 基于github classroom，可方便建立开发用的git repository，并可基于github的 codespace （在线版ubuntu +vscode）在线开发使用。整个开发环境仅仅需要一个网络浏览器。 + + 1. 在网络浏览器中用自己的 id 登录 github.com + 2. 接收 `第一个实验 setup-env-run-os1 的在线邀请 `_ ，根据提示一路选择OK即可。 + 3. 完成第二步后，你的第一个 setup-env-run-os1 的 github repository 会被自动建立好，点击此github repository的链接，就可看到你要完成的第一个实验了。 + 4. 在你的第一个实验的网页的中上部可以看到一个醒目的 `code` 绿色按钮，点击后，可以进一步看到 `codespace` 标签和醒目的 `create codesapce on main` 绿色按钮。请点击这个绿色按钮，就可以进入到在线的ubuntu +vscode环境中 + 5. 再按照下面的环境安装提示在vscode的 `console` 中安装配置开发环境：rustc，qemu等工具。 + 6. 在vscode的 `console` 中执行 `make setupclassroom` （该命令仅执行一次）配置githubclassroom 自动评分功能。 + 7. 然后就可以基于在线vscode进行开发、运行、提交等完整的实验过程了。 + + 上述的3，4，5步不是必须的，你也可以线下本地开发。 + + 本章一步步实现了支持打印字符串的简单操作系统。 获取本章代码： @@ -45,6 +62,9 @@ $ git clone https://github.com/LearningOS/rust-based-os-comp2022.git $ cd rust-based-os-comp2022/ + $ make setupclassroom //注意：这一步很重要，是用于github classroom自动评测你的工作。这一步只需在首次克隆项目仓库时执行一次，以后一般就不用执行了，除非 .github/workflows/classroom.yml发生了编号。 + + 运行本章代码，并设置日志级别为 ``TRACE``：