doc: 更新构建系统文档

This commit is contained in:
fslongjin 2022-07-25 23:44:05 +08:00
parent 6cb97a55a8
commit 047c5302e8

View File

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