Browse Source

doc: 更新构建系统文档

fslongjin 2 years ago
parent
commit
047c5302e8
1 changed files with 96 additions and 27 deletions
  1. 96 27
      docs/introduction/build_system.md

+ 96 - 27
docs/introduction/build_system.md

@@ -1,50 +1,119 @@
 # 构建DragonOS
 
-## 软件依赖
+## 从Docker构建(推荐)
 
-- GNU make
-- GCC >= 8.3.0
-- xorriso
-- grub 2.06
+  为减轻配置环境的负担,DragonOS发布了一个Docker编译环境,便于开发者运行DragonOS。我们强烈建议您采用这种方式来运行DragonOS。
 
-## 开发环境
+  本节假设以下操作均在Linux下进行。
 
-​    目前,DragonOS在Deepin V20上进行开发。经测试,在Debian bullseye上,可以正常编译、运行。建议使用Docker运行debian镜像进行开发。(后期将会发布开发环境的docker镜像)
+### 安装Docker
 
-## 运行环境
+  您可以在docker官网下载安装docker-ce.
 
-1. qemu 6.2.0(编译安装并启用gdb调试选项)
-2. gdb
-3. VNC Viewer
+> 详细信息请转到: https://docs.docker.com/engine/install/
 
-## 编译DragonOS
+### 获取DragonOS编译镜像
 
-1. 安装编译及运行环境
-2. 进入DragonOS文件夹
-3. 输入命令:`make -j 16`即可编译
+  当您成功安装了docker之后,您可以通过以下命令,下载DragonOS的编译镜像:
+
+```shell
+sudo docker pull dragonos/dragonos-dev
+```
+
+### 安装qemu虚拟机
 
-## 运行DragonOS
+  在本节中,我们建议您采用命令行安装qemu:
 
-### 安装软件依赖
+```shell
+sudo apt install -y qemu qemu-system qemu-system-x86_64 qemu-kvm
+```
 
-  在运行DragonOS之前,需要先安装需要先安装上述软件依赖。
+  请留意,若您的Linux系统是在虚拟机中运行的,还请您在您的VMware/Virtual Box虚拟机的处理器设置选项卡中,开启Intel VT-x或AMD-V选项,否则,DragonOS将无法运行。
+
+### 下载DragonOS的源代码
+
+  假设您的计算机上已经安装了git,您可以通过以下命令,获得DragonOS的最新的源代码:
+
+```shell
+git clone https://github.com/fslongjin/DragonOS
+cd DragonOS
+```
 
 ### 创建磁盘镜像
 
-#### 概述
+  首先,您需要使用tools文件夹下的create_hdd_image.sh,创建一块虚拟磁盘镜像。您需要在tools文件夹下运行此命令。
+
+```shell
+bash create_hdd_image.sh
+```
+
+### 运行DragonOS
+
+  如果不出意外的话,这将是运行DragonOS的最后一步。您只需要在DragonOS的根目录下方,执行以下命令,即可运行DragonOS。
+
+```shell
+bash run.sh --docker
+```
+
+  若输入密码后仍提示权限不足,您可以使用以下命令运行:
+
+```shell
+sudo bash run.sh --docker
+```
+
+  稍等片刻,DragonOS将会被运行。
+
+  在qemu虚拟机被启动后,我们需要在控制台输入字母`c`,然后回车。这样,虚拟机就会开始执行。
+
+
+
+## 手动搭建开发环境
+
+  若您追求快速的编译速度,以及完整的开发调试支持,且愿意花费半个小时到两个小时的时间来配置开发环境的话,该小节的内容能帮助到您。
 
-  使用tools目录下的脚本,创建一至少为16MB磁盘镜像(类型选择raw)。并建立MBR分区表,然后将第一个分区格式化为FAT32分区。
+### 软件依赖
 
-  在完成以上操作后,将创建的磁盘文件移动至bin文件夹(若不存在,则需要您手动创建),并将其重命名为“disk.img”
+  您需要编译安装以下软件依赖。他们的源代码可以在对应项目的官方网站上获得。
 
-  最后,在DragonOS目录下运行 `bash run.sh`脚本,将会完成编译、文件拷贝、内核镜像打包、启动qemu虚拟机的全过程。当qemu虚拟机启动后,即可使用VNC Viewer连接到虚拟机。
+- grub 2.06 (不必使用sudo权限进行install)
+- qemu 6.2.0 (启用所有选项)
 
-#### 具体操作方法
+  需要注意的是,编译安装qemu将会是一件费时费力的工作,它可能需要花费你40分钟以上的时间。
+
+  对于以下软件依赖,建议您使用系统自带的包管理器进行安装。
+
+- gcc >= 8.3.0
+
+- xorriso
+
+- fdisk
+
+- make
+
+- VNC Viewer
+
+- gdb
+
+
+
+### 编译DragonOS
+
+1. 安装编译及运行环境
+2. 进入DragonOS文件夹
+3. 输入命令:`make -j 16`即可编译
+
+
+
+### 创建磁盘镜像
 
   首先,您需要使用`sudo`权限运行`tools/create_hdd_image.sh`,为DragonOS创建一块磁盘镜像文件。该脚本会自动完成创建磁盘镜像的工作,并将其移动到`bin/`目录下。
 
-**原理**
+### 运行DragonOS
+
+  至此,准备工作已经完成,您可以在DragonOS项目的根目录下,输入
+
+```shell
+bash run.sh
+```
 
-  该脚本在创建磁盘镜像之后,会自动调用fdisk,您需要在fdisk之中对虚拟磁盘进行初始化。您需要使用fdisk把磁盘的分区表设置为MBR格式,并创建1个分区。具体操作为:输入o、n, 然后按4次回车,直到回到fdisk的默认界面,再输入w即可,按顺序输入,并且,每次输入完成后要按下回车。完成操作后,磁盘镜像`disk.img`将会被创建。
-    
-  至此,准备工作已经完成,您可以运行`run.sh`,然后DragonOS将会被启动。
+  然后,DragonOS将会被启动,您可以通过VNC Viewer连接至虚拟机。在qemu虚拟机被启动后,我们需要在控制台输入字母`c`,然后回车。这样,虚拟机就会开始执行。