Merge branch 'device-sys'

[lunaix-os.git] / README.md

diff --git a/README.md b/README.md
index a349d2371799732a71a7a1c47f382a5ad32b1f47..77920e7a3a539c5bd0d97d7b0bedf8f466b58def 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,12 +22,13 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 + 内存管理与按需分页（Demand Paging）
 + 键盘输入
 + 多进程
-+ 17个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
++ 47个常见的Linux/POSIX系统调用（[附录1](#appendix1)）
 + 用户模式
 + 信号机制
 + PCI 3.0
 + PCIe 1.1 (WIP)
-+ Serial ATA AHCI (WIP)
++ Serial ATA AHCI
++ 文件系统 (WIP)
 
 ## 目录结构
 
@@ -67,7 +68,7 @@ LunaixOS - 一个简单的，详细的，POSIX兼容的（但愿！），带有
 运行该操作系统需要一个虚拟磁盘镜像，可以使用如下命令快速创建一个：
 
 ```bash
-qemu-img create -f vdi machine/disk1.vdi 128M
+qemu-img create -f vdi machine/disk0.vdi 128M
 ```
 
 如果你想要使用别的磁盘镜像，需要修改`configs/make-debug-tool`
@@ -97,10 +98,6 @@ qemu-img create -f vdi machine/disk1.vdi 128M
 
 正常，**因为Bochs不支持SATA**。请使用QEMU或VirtualBox。
 
-#### 问题#4：键盘的上下方向键（用于滚屏）在VirtualBox下有时不好使
-
-可以试试`Shift+<方向键>`，这个问题的解决需要重写键盘驱动的状态机。我会找时间去做，毕竟这不是燃眉之急。
-
 ## 参考教程
 
 **没有！！** 本教程以及该操作系统均为原创，没有基于任何市面上现行的操作系统开发教程，且并非是基于任何的开源内核的二次开发。
@@ -147,7 +144,7 @@ qemu-img create -f vdi machine/disk1.vdi 128M
 
 ## 附录1：支持的系统调用<a id="appendix1"></a>
 
-### Unix/Linux/POSIX
+**Unix/Linux/POSIX**
 1. `sleep(3)`
 1. `wait(2)`
 1. `waitpid(2)`
@@ -165,10 +162,44 @@ qemu-img create -f vdi machine/disk1.vdi 128M
 1. `kill(2)`
 1. `sigpending(2)`
 1. `sigsuspend(2)`
-
-### LunaixOS自有
+2. `read(2)`
+2. `write(2)`
+2. `open(2)`
+2. `close(2)`
+2. `mkdir(2)`※
+2. `lseek(2)`
+2. `readdir(2)`
+2. `readlink(2)`※
+2. `readlinkat(2)`※
+2. `rmdir(2)`※
+2. `unlink(2)`※
+2. `unlinkat(2)`※
+2. `link(2)`※
+2. `fsync(2)`※
+2. `dup(2)`
+2. `dup2(2)`
+2. `symlink(2)`※
+2. `chdir(2)`
+2. `fchdir(2)`
+2. `getcwd(2)`
+2. `rename(2)`※
+2. `mount(2)`
+2. `unmount` (a.k.a `umount(2)`)※
+2. `getxattr(2)`※
+2. `setxattr(2)`※
+2. `fgetxattr(2)`※
+2. `fsetxattr(2)`※
+2. `ioctl(2)`※
+2. `getpgid(2)`
+2. `setpgid(2)`
+
+**LunaixOS自有**
 
 1. `yield`
+2. `geterrno`
+3. `realpathat`
+
+( **※**：该系统调用暂未经过测试 )
 
 ## 附录2：编译gcc作为交叉编译器<a id="appendix2"></a>
 
@@ -226,9 +257,22 @@ make all-gcc &&\
 ```
 8. 验证安装：执行`i686-elf-gcc -dumpmachine`，输出应该为：`i686-elf`
 
+**将新编译好的GCC永久添加到`PATH`环境变量**
+
+虽然这是一个常识性的操作，但考虑到许多人都会忽略这一个额外的步骤，在这里特此做出提示。
+
+要想实现这一点，只需要在shell的配置文件的末尾添加：`export PATH="<上述的安装路径>/bin:$PATH"`。
+
+这个配置文件是取决于你使用的shell，如zsh就是`${HOME}/.zshrc`，bash则是`${HOME}/.bashrc`；或者你嫌麻烦的，懒得区分，你也可以直接修改全局的`/etc/profile`文件，一劳永逸（但不推荐这样做）。
+
+至于其他的情况，由于这个步骤其实在网上是随处可查的，所以就不在这里赘述了。
+
 ## 附录3：Issue的提交<a id="appendix3"></a>
 
+由于目前LunaixOS没有一个完善强大的内核追踪功能。假若Lunaix的运行出现任何问题，还请按照以下的描述，在Issue里面提供详细的信息。
+
 最好提供：
++ 可用于复现问题的描述和指引（如Lunaix运行平台的软硬件配置）
 + 错误症状描述
 + （如可能）运行截图
 + 错误消息（如果给出）