编写 README.md

6 years ago · fbccd9a7cf
parent 8ff361ffff
commit fbccd9a7cf
1 changed files with 20 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +0,0 @@
-docs/src/README.md
--- a/README.md
+++ b/README.md
@ -0,0 +1,20 @@
+# zCore Tutorial
+
+## 仓库目录
+
+* `docs/`: 教学实验指导
+* `zcore`: 操作系统代码
+
+## 实验指导
+
+基于 mdBook，目前目前已经部署到了 [GitHub Pages](https://rcore-os.github.io/zCore-Tutorial/) 上面。
+
+### 文档本地使用方法
+
+```bash
+git clone https://github.com/rcore-os/zCore-Tutorial.git
+cd zCore-Tutorial
+cargo install mdbook
+mdbook serve docs
+```
+