diff --git a/README.md b/README.md index bed9b773a5b7ad949a1079340448a18832bdb5fc..23cfe7d9541fee160f61cbc50f291dc581000764 100644 --- a/README.md +++ b/README.md @@ -5,23 +5,21 @@ [文档目录](SUMMARY.md) -# 一、NXOS 简介 +`NXOS`(即`Next XBook Operating System`)是一个跨平台的简洁、高性能、高稳定性的支持多核的混合内核,它将应用于桌面操作系统、服务器操作系统、移动终端操作系统等领域。 -`NXOS`是`Next XBook Operating System`的意思,是一个跨平台的简洁、高性能、高稳定性的支持多核的混合内核,它将应用于桌面操作系统领域,服务器操作系统领域以及移动终端操作系统领域。 - -我们以简洁、高效、稳定为核心,用比较简洁且高效的方式去实现一些功能,去掉一些复杂,冗杂的功能,化繁为简。 +我们以简洁、高效、稳定为核心,用比较简洁高效的方式去实现一些功能,去掉一些复杂冗余的功能,化繁为简。 `NXOS` 是一个分时多进程/多线程(也支持实时优先级),支持 `MMU` 的现代操作系统,它和 `Linux` 内核, `WindowsNT` 内核是同一个数量级的。 -`NXOS`采用混合内核架构,即宏内核和微内核相结合。优势是减小内核代码,增加功能可扩展性,功能模块是独立的进程,添加和删除模块就是进程的创建和关闭。 +`NXOS` 采用混合内核架构,即宏内核和微内核相结合。这样可以减小内核代码,增加功能可扩展性,功能模块是独立的进程,添加和删除模块就是进程的创建和关闭。 -# 二、NXOS 目标 +# 目标 -`NXOS` 的初期目标是运行在一些高性能的嵌入式设备上,比如手机终端,游戏掌机等。后期目标是能够作为服务器使用,甚至是桌面操作系统使用。 +`NXOS` 的初期目标是运行在一些高性能的嵌入式设备上,比如手机终端,游戏掌机等。后期目标是能够作为服务器使用,甚至是作为桌面操作系统使用。 -内核就只负责基础功能的支持,平台移植和驱动的移植,具体如何使用,可以根据用户态的 `sdk` 和服务,应用程序去构建应用。 +内核就只负责**基础功能**的支持,平台移植和驱动的移植,具体如何使用,可以根据用户态的 `sdk` 和服务,应用程序去构建应用。 -# 三、内核功能 +# 功能 `NXOS` 支持 `SMP` 多核,多架构,多平台。 @@ -41,7 +39,7 @@ | 彩色日志输出 | 支持配置日志输出时间,格式,名称,颜色,消息等级等 | | 其他功能正在开发中,敬请期待! | ... | -# 四、平台支持 +# 平台支持 | ARCH | PLATFORM |STATUS | | ------- | ---------- | ---------- | @@ -55,14 +53,6 @@ | arm32 | qemu | TODO | |loongArch| qemu | TODO | -# 五、许可协议 +# 许可协议 `NXOS`采用 `Apache-2.0` 开源协议,可以自由的复制和修改代码,只需要保留版权说明即可,无潜在的商业风险。 - -# 六、文档生成 - -文档生成就是将markdown源文件生成为html文件,可以使用浏览器去浏览。 -```shell -# 使用gitbook 命令生成文档,生成文件在目录_book中 -gitbook serve -``` diff --git a/SUMMARY.md b/SUMMARY.md index f31d9f6bb9f8e36b576d1209f9dc12a028b549c5..6035771056679aaddcdb5ddd8671922b2622d4c9 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,5 +1,3 @@ -# Summary - - NXOS文档中心 - 简介 - [NXOS 简介](README.md) @@ -48,3 +46,5 @@ - [菜单配置](tutorial/menuconfig.md) - [工具链](tutorial/toolchains.md) - [单元测试](tutorial/utest.md) + - 更多 + - [文档生成](tutorial/doc-generation.md) \ No newline at end of file diff --git a/tutorial/code-style.md b/tutorial/code-style.md index dd57271ef48e9d0d19099a20861ee428dc80e46a..a4dd2866a406532e15977344f3b788d92288bd93 100644 --- a/tutorial/code-style.md +++ b/tutorial/code-style.md @@ -1,6 +1,6 @@ # NXOS 编程风格 -本文档是关于**NXOS**的代码编程风格的描述。开发者必须遵守本文档规范进行开发。NXOS系统内核使用C语言作为主要开发语言,因此以下规则仅仅适用于C语言代码。 +本文档是关于**NXOS**的代码编程风格的描述。开发者须遵守本文档规范进行开发。NXOS系统内核使用C语言作为主要开发语言,因此以下规则仅仅适用于C语言代码。 ## 1.目录名称 diff --git a/tutorial/doc-generation.md b/tutorial/doc-generation.md new file mode 100644 index 0000000000000000000000000000000000000000..864248427eb894a0a6290b15b061d7f6c874888f --- /dev/null +++ b/tutorial/doc-generation.md @@ -0,0 +1,7 @@ +# 文档生成 + +文档生成就是将markdown源文件生成为html文件,可以使用浏览器去浏览。 +```shell +# 使用gitbook 命令生成文档,生成文件在目录_book中 +gitbook serve +``` \ No newline at end of file