refactor: rewrite kernel's make script

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index 7740e1b6d1b3bb3c94258b647ae9fe9550c185f7..7e1631835d667aa239f8588501e2674f8cf2c5d8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 </p>
 
 <p align="center">
 </p>
 
 <p align="center">

-  <span>简体中文</span> | <a href="docs/README_en.md">English</a>
+  <a href="#lunaixos-project">简体中文</a> | <a href="docs/README_en.md">English</a>

 </p>
 
 # LunaixOS Project
 </p>
 
 # LunaixOS Project


@@ -33,8 +33,10 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
   + 虚拟文件系统
   + ISO9660
     + 原生
   + 虚拟文件系统
   + ISO9660
     + 原生

-    + Rock Ridge拓展 (WIP)
+    + Rock Ridge拓展

 + 远程GDB串口调试 (COM1@9600Bd)
 + 远程GDB串口调试 (COM1@9600Bd)

++ 用户程序加载与执行
++ 动态链接 (WIP)

 
 已经测试过的环境：
 
 
 已经测试过的环境：
 


@@ -53,6 +55,8 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 ## 编译与构建
 
 
 ## 编译与构建
 

+### 环境搭建
+

 构建该项目需要满足以下条件：
 
 + gcc (目标平台: i686-elf)
 构建该项目需要满足以下条件：
 
 + gcc (目标平台: i686-elf)


@@ -63,6 +67,12 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 **注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
 
 
 **注意：gcc不能是本机自带的，必须要从源码编译，并配置目标平台为：`i686-elf`，以进行交叉编译。配置过程可参考[附录二：编译gcc作为交叉编译器](#appendix2)。**
 

+### Docker镜像
+
+对于开发环境，本项目也提供了Docker镜像封装。开箱即用，无需配置，非常适合懒人或惜时者。详细使用方法请转到：[Lunaix OSDK项目](https://github.com/Minep/os-devkit)。
+
+### 构建选项
+

 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
 
 本项目支持的make命令：
 假若条件满足，那么可以直接执行`make all`进行构建，完成后可在生成的`build`目录下找到可引导的iso。
 
 本项目支持的make命令：


@@ -79,7 +89,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 
 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 
 
 **※：由于在`-O2`模式下，GCC会进行CSE优化，这导致LunaixOS会出现一些非常奇怪、离谱的bug，从而影响到基本运行。具体原因有待调查。**
 

-## 运行以及Issue
+## 运行，分支以及Issue

 
 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
 
 
 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
 


@@ -99,7 +109,9 @@ qemu-img create -f vdi machine/disk0.vdi 128M
 
 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 
 
 有很多办法去创建一个虚拟磁盘，比如[qemu-img](https://qemu-project.gitlab.io/qemu/system/images.html)。
 

-在大多数情况下，我都会尽量保证本机运行无误后，push到仓库中。同时，该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)
+主分支一般是稳定的。因为在大多数情况下，我都会尽量保证本机运行无误后，push到该分支中。至于其他的分支，则是作为标记或者是开发中的功能。前者标记用分支一般会很快删掉；后者开发分支不能保证稳定性，这些分支的代码有可能没有经过测试，但可以作为Lunaix当前开发进度的参考。
+
+该系统是经过虚拟机和真机测试。如果发现在使用`make all`之后，虚拟机中运行报错，则一般是编译器优化问题。这个问题笔者一般很快就会修复，如果你使用别的版本的gcc（笔者版本11.2），出现了此问题，欢迎提issue。请参考[附录3：Issue的提交](#appendix3)

 
 下面列出一些可能会出现的问题。
 
 
 下面列出一些可能会出现的问题。