diff --git a/README.md b/README.md deleted file mode 120000 index 95cf2af..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/src/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..05c2959 --- /dev/null +++ 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 +``` +