remove the includes that obsoleted since last refactoring

[lunaix-os.git] / lunaix-os / README.md

diff --git a/lunaix-os/README.md b/lunaix-os/README.md
index f3d24d07618e63cc57badb06e8aa0b0a15c866a8..a5a2cdabfd5f8651bc80a190cf617509fd91512e 100644 (file)
--- a/lunaix-os/README.md
+++ b/lunaix-os/README.md
@@ -1,26 +1,23 @@
-# LunaixOS 源代码
+# Luniax Kernel
 
-我知道这个目录结构看起来相当的劝退。特别是并没有像初代Linux那种一个文件夹里就只是一堆文件的简单朴素。但至少，就我而言，把结构细分一点儿总是好的。
+This is the source code tree for lunaix kernel.
 
-## 目录结构
+## Organisation
+
+| Directory | Description |
+| -------   | ------      |
+| `arch`    | ISA specific code |
+| `hal`     | drivers |
+| `includes`| headers |
+| `kernel`  | kernel source files |
+| `link`    | linker scripts |
+| `libs`    | kernel library |
+| `makeinc` | includes for makefile |
+| `scripts` | auxiliary scripts |
+| `tests`   | kernel test cases |
+| `usr`     | stock user space environment (debug only) |
+
+## Build System
+
+See: [Build system of Lunaix](./scripts/build-tools/README.md)
 
-+ `arch` 平台相关代码，LunaixOS的内核引导就在这里。
-+ `hal`  硬件抽象层，存放主板相关的代码，提供了一些访问主板功能（比如CPU，计时器）的抽象
-+ `includes`  所有头文件
-+ `debug`  内核调试服务器
-+ `config` makefile配置问题
-+ `kernel` 这里就是内核了
-  + `asm` 共内核使用的，且平台相关的代码。
-  + `ds` 提供一些基本的数据结构支持。
-  + `mm` 各类内存管理器。
-  + `peripheral` 外部设备驱动（如键盘）。
-  + `time` 为内核提供基本的时间，计时服务。
-  + `tty` 提供基本的显存操作服务。
-  + `fs` 文件系统。
-  + `device` 设备（通用）抽象层
-  + `block` 块设备抽象层
-  + `process` 进程相关
-  + `demos` 简单的测试程序
-+ `lib` 一些内核使用的运行时库，主要提供是内核模式下的一些C标准库里的实现。
-+ `link` 链接器脚本
-+ `scripts` 其他脚本（如：用于代码生成）
\ No newline at end of file