Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/general-commands.html b/commands/general-commands.html
new file mode 100644
index 0000000..515f799
--- /dev/null
+++ b/commands/general-commands.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/index.html b/commands/index.html
new file mode 100644
index 0000000..173259a
--- /dev/null
+++ b/commands/index.html
@@ -0,0 +1,266 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 通用命令
+-
+
- + + +
- + + +
- + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-build.html b/commands/ruxgo-build.html
new file mode 100644
index 0000000..1d26322
--- /dev/null
+++ b/commands/ruxgo-build.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ruxgo 命令
+参数信息：
+A Cargo-like build tool for building C and C++ applications
+
+Usage: ruxgo [OPTIONS] [CHOICES]... [COMMAND]
+
+Commands:
+ init Initialize a new project Defaults to C++ if no language is specified
+ pkg Package management
+ config Configuration settings
+ help Print this message or the help of the given subcommand(s)
+
+Arguments:
+ [CHOICES]... Choose which parts to delete
+
+Options:
+ -b, --build Build your project
+ -c, --clean Clean the obj and bin intermediates
+ -r, --run Run the executable
+ --path <PATH> Path argument to pass to switch to the specified directory
+ --bin-args=<BIN_ARGS>... Arguments to pass to the executable when running
+ --gen-cc Generate compile_commands.json
+ --gen-vsc Generate .vscode/c_cpp_properties.json
+ -h, --help Print help
+ -V, --version Print version
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-clean.html b/commands/ruxgo-clean.html
new file mode 100644
index 0000000..9c2bfab
--- /dev/null
+++ b/commands/ruxgo-clean.html
@@ -0,0 +1,251 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo -b
+ruxgo -b 命令用于构建您的项目，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要构建当前项目，您可以执行以下操作：
+ruxgo -b [--path <路径>] [--gen-cc] [--gen-vsc]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行构建操作。如果不提供，则默认在当前目录下执行。
+--gen-cc: 生成compile_commands.json文件，它包含了编译项目的所有命令。
+--gen-vsc: 生成 Visual Studio Code 的配置文件.vscode/c_cpp_properties.json，它包含了项目的编译器配置和头文件路径。
+
命令行为
+当执行 ruxgo -b 命令后，将会在当前目录下创建一个名为 ruxgo_bld/ 的构建目录，包括以下内容：
ruxgo_bld/
+├── bin/
+├── obj_linux/ 或 obj_win32/
+├── target/
+├── *.hash
+├── compile_commands.json (如果启用了gen_cc)
+├── .vscode/c_cpp_properties.json (如果启用了gen_vsc)
+└── ruxmusl/ (如果使用了ruxmusl用户库)
+-
+
bin/： 存放构建过程中生成的静态库、动态库、目标文件或可执行文件 。
+obj_linux/obj_win32： 存放编译源码生成的中间对象文件 （ *.o ）。
+target： 存放构建 ruxos 后生成的 target 文件。
+*.hash： 存放构建过程中生成的 hash 文件，用来实现增量构建。
+compile_commands.json： 存放构建过程中的所有编译命令，如果启用了 gen_cc。
+.vscode/c_cpp_properties.json： 存放项目的 vscode 配置，如果启用了 gen_vsc。
+ruxmusl/： 存放构建 ruxmusl 后生成的中间文件及静态库，如果使用了 ruxmusl 。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-help.html b/commands/ruxgo-help.html
new file mode 100644
index 0000000..e8aaf47
--- /dev/null
+++ b/commands/ruxgo-help.html
@@ -0,0 +1,261 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo -c
+ruxgo -c 命令用于清理项目，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要清理构建的项目，您可以执行以下操作：
+ruxgo -c [--path <路径>]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行清理操作。如果不提供，则默认在当前目录下执行。
+
命令行为
+执行 ruxgo -c 命令后，ruxgo 提供了一个多选界面，让用户选择要清理的过程文件，按下 Esc 键则退出当前命令，按下空格（Space）键则选中要清理的项目。具体内容如下：
-
+
All/： 删除项目所有内容。
+App_bins/： 删除构建的 app 可执行文件及其相关库。
+Obj/： 删除编译源码生成的中间对象文件（*.o）。
+OS/： 删除 ruxos 的构建目录。
+Ulib/： 删除 Ulib 的构建内容，如ruxlibc或ruxmusl。
+
需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-init.html b/commands/ruxgo-init.html
new file mode 100644
index 0000000..9586158
--- /dev/null
+++ b/commands/ruxgo-init.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo help
+ruxgo help 命令用于显示 ruxgo 工具的帮助信息，包括其各个子命令的详细说明。
使用方式
+要获取 ruxgo 工具或其任一子命令的帮助信息，您可以执行以下操作：
ruxgo help [子命令]
+示例
+-
+
-
+
显示
+ruxgo的总体帮助信息：
+ruxgo help +
+ -
+
查看关于
+init命令的详细帮助：
+ruxgo help init +
+ -
+
查看关于
+pkg命令的详细帮助：
+ruxgo help pkg +
+
提示
+-
+
- 不带任何子命令时，
ruxgo help将显示ruxgo工具的总体帮助信息，包括所有可用的命令和选项。
+ - 当指定一个子命令时，如
ruxgo help init，将显示该特定子命令的详细帮助信息。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-pkg.html b/commands/ruxgo-pkg.html
new file mode 100644
index 0000000..0de419e
--- /dev/null
+++ b/commands/ruxgo-pkg.html
@@ -0,0 +1,288 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo init
+当您开始一个新项目时，通常需要一些基本的框架设置。ruxgo 提供了 init 命令来帮助您快速开始一个新的 C 或 C++ 项目。
使用方式
+要初始化一个新项目，使用以下命令：
+ruxgo init <项目名称> [--c] [--cpp]
+-
+
<项目名称>: 指定新项目的名称。
+--c: 初始化一个 C 语言项目。
+--cpp: 初始化一个 C++ 语言项目。
+
注意：--c 和 --cpp 选项不能同时使用。如果都不指定，则默认创建一个 C++ 项目。
命令行为
+当运行 ruxgo init 命令后，将会在当前目录下创建一个新的项目目录，其中包括以下内容：
<项目名称>/
+├── src/
+│ ├── main.c 或 main.cpp
+│ └── include/
+├── .gitignore
+├── README.md
+├── LICENSE
+└── config_<platform>.toml
+-
+
src/：包含所有源代码文件和配置文件。
+src/include：用于存放头文件。
+.gitignore：用于指定 git 忽略的文件和目录。
+README.md和LICENSE：项目的基本文档。
+config_<platform>.toml：项目的配置文件，根据运行平台的不同而变化（例如config_linux.toml或config_win32.toml）。
+
示例
+-
+
-
+
初始化一个名为 “my_project” 的 C++ 项目：
+
+ruxgo init my_project --cpp +
+ -
+
初始化一个名为 “my_project” 的 C 项目：
+
+ruxgo init my_project --c +
+
提示
+-
+
- 使用
--help选项可以查看更多命令帮助。
+ - 当项目目录已经存在时，
ruxgo init将不会继续执行，并显示错误信息。
+ - 通过修改
config_<platform>.toml文件，您可以自定义编译器选项和其他构建设置。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/commands/ruxgo-run.html b/commands/ruxgo-run.html
new file mode 100644
index 0000000..aa5ec51
--- /dev/null
+++ b/commands/ruxgo-run.html
@@ -0,0 +1,244 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo pkg
+ruxgo pkg 命令用于管理软件包，包括列出、拉取、更新和清理软件包等。
使用方式
+要使用 ruxgo pkg 命令，您可以执行以下操作：
ruxgo pkg [选项]
+可选项如下：
+-
+
-l, --list: 列出远程仓库中可用的软件包。
+-p, --pull <PKG_NAME>: 从远程仓库拉取特定软件包。
+-r, --run <APP_BIN>: 运行特定的应用程序二进制文件。
+-u, --update <PKG_NAME>: 更新特定软件包。
+-c, --clean <PKG_NAME>: 清理特定软件包。
+--clean-all: 清理所有软件包。
+-h, --help: 打印帮助信息。
+
下载的文件保存在 ruxgo_pkg/ 目录中，具体内容如下：
-
+
app-bin/: 存放 app 可执行文件及其对应脚本。
+ruxos/: ruxos 存储位置。
+rux-*/: app 源码存储位置。
+cache/: 存放 packages 信息的缓存。
+
示例
+-
+
-
+
列出所有可用的软件包：
+
+ruxgo pkg --list +
+ -
+
从远程仓库拉取名为 “example_pkg” 的软件包：
+
+ruxgo pkg --pull example_pkg +
+ -
+
更新名为 “example_pkg” 的软件包：
+
+ruxgo pkg --update example_pkg +
+ -
+
清理名为 “example_pkg” 的软件包：
+
+ruxgo pkg --clean example_pkg +
+ -
+
清理所有软件包：
+
+ruxgo pkg --clean-all +
+
提示
+-
+
- 使用
--help选项可以查看更多命令帮助。
+ - 确保在执行任何软件包管理操作之前，您的系统已连接到互联网。 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/css/chrome.css b/css/chrome.css
new file mode 100644
index 0000000..83b7969
--- /dev/null
+++ b/css/chrome.css
@@ -0,0 +1,604 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/css/general.css b/css/general.css
new file mode 100644
index 0000000..7670b08
--- /dev/null
+++ b/css/general.css
@@ -0,0 +1,232 @@
+/* Base styles and content styles */
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/css/print.css b/css/print.css
new file mode 100644
index 0000000..80ec3a5
--- /dev/null
+++ b/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/css/variables.css b/css/variables.css
new file mode 100644
index 0000000..0da55e8
--- /dev/null
+++ b/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/elasticlunr.min.js b/elasticlunr.min.js
new file mode 100644
index 0000000..94b20dd
--- /dev/null
+++ b/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ruxgo -r
+ruxgo -r 命令用于运行项目中的可执行文件，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要运行构建的项目，您可以执行以下操作：
+ruxgo -r [--path <路径>] [--bin-args <参数列表>]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行运行操作。如果不提供，则默认在当前目录下执行。
+--bin-args=<参数列表>: 提供一系列运行时参数传递给项目的可执行文件，参数跟在=后面且以逗号分隔。
+
命令行为
+执行 ruxgo -r 命令后，将会运行 bin/ 目录下的可执行文件。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/build_project.html b/guide/build_project.html
new file mode 100644
index 0000000..5b7b8a6
--- /dev/null
+++ b/guide/build_project.html
@@ -0,0 +1,272 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 构建描述说明
+Ruxgo 选择 TOML 文件格式进行构建描述。这是一个旨在易于阅读和编写的声明性文件格式，特别适用于 RuxOS 的构建配置需求。
+在具体实现方面，Ruxgo 采用 config_<platform>.toml 文件来根据不同的平台配置项目。例如，针对 Linux 平台采用 config_linux.toml 文件，针对 Windows 平台则采用 config_win32.toml 文件。下图是 Ruxgo 的源代码文件组织示意：
+ 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/images/MakeVsRuxgo.svg b/guide/images/MakeVsRuxgo.svg
new file mode 100644
index 0000000..6110793
--- /dev/null
+++ b/guide/images/MakeVsRuxgo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/guide/images/Modules.svg b/guide/images/Modules.svg
new file mode 100644
index 0000000..2eee4ed
--- /dev/null
+++ b/guide/images/Modules.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/guide/images/module_design.svg b/guide/images/module_design.svg
new file mode 100644
index 0000000..3464bf8
--- /dev/null
+++ b/guide/images/module_design.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/guide/images/pre_Make.svg b/guide/images/pre_Make.svg
new file mode 100644
index 0000000..211f369
--- /dev/null
+++ b/guide/images/pre_Make.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/guide/images/ruxgo-logo1.svg b/guide/images/ruxgo-logo1.svg
new file mode 100644
index 0000000..8ee5414
--- /dev/null
+++ b/guide/images/ruxgo-logo1.svg
@@ -0,0 +1,17 @@
+
\ No newline at end of file
diff --git a/guide/images/source_tree.svg b/guide/images/source_tree.svg
new file mode 100644
index 0000000..55b23cd
--- /dev/null
+++ b/guide/images/source_tree.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/guide/index.html b/guide/index.html
new file mode 100644
index 0000000..55d2d73
--- /dev/null
+++ b/guide/index.html
@@ -0,0 +1,234 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 构建一个项目
+可以使用 Ruxgo 快速开始一个项目。首先，确保您的系统上已安装 ruxgo。如果尚未安装，请参考 Ruxgo 安装 。
+之后使用如下命令初始化一个 C 项目：
+ruxgo init my_project --c
+初始化完成后，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+如果您想在 RuxOS 上运行，将 my_project 下的config_<platform>.toml文件修改为如下:
[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = []
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+mode = "release"
+log = "info"
+
+[os.platform.qemu]
+graphic = "n"
+
+[[targets]]
+name = "main"
+src = "./src/"
+include_dir = "./src/include/"
+type = "exe"
+cflags = "-g -Wall -Wextra"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = []
+之后将 my_project 复制到 ruxos/apps/c 目录下，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/ruxgo_goals.html b/guide/ruxgo_goals.html
new file mode 100644
index 0000000..013e1a2
--- /dev/null
+++ b/guide/ruxgo_goals.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ruxgo 指南
+本节将为您提供有关如何使用 Ruxgo 开发 C/C++ 应用程序的所有信息。
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/toml_design.html b/guide/toml_design.html
new file mode 100644
index 0000000..4f215ea
--- /dev/null
+++ b/guide/toml_design.html
@@ -0,0 +1,363 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ruxgo 设计目标
+Ruxgo 旨在为 RuxOS 提供一个构件化支持、高性能、用户友好且生态完善的构建系统。其开发专注于满足 RuxOS 的组装构建需求，同时也支持广泛的类 Unix 系统及 Windows 系统上基于 C/C++ 开发的应用程序。下图是改用 Ruxgo 构建应用程序的设计示意，整个构建描述只需要一个 Toml 文件：
+
Ruxgo 的具体设计目标包括：
+（1）对 RuxOS 的构件化支持：
+Ruxgo 将提供更细粒度的构件和依赖管理能力，支持复杂配置的灵活性，减少手动干预。通过自动化构建流程，Ruxgo 将能够根据应用需求自动选择和配置所需组件，从而提高构建过程的效率。
+（2）对应用程序的构件化支持：
+为了应对应用程序在开发和移植过程中的挑战，Ruxgo 将支持应用程序的功能分解与组装。它将允许应用程序仅包含对于在 RuxOS 上运行所必需的功能模块，同时提供必要的接口来适配和集成系统库和函数调用，确保应用程序的兼容性和性能。
+（3）简洁明了的构建描述：
+Ruxgo 的设计理念核心在于提升用户体验，旨在通过简洁明了的构建描述文件和易于理解的 API 接口，减少软件开发人员在构建过程中的负担，从而降低学习曲线。这样，软件开发人员能够更多地专注于源代码的编写和创新，而非耗费大量时间和精力在理解和使用构建工具上。
+（4）高性能的构建:
+Ruxgo 旨在最小化自身的构建系统开销，以实现快速的响应。同时采用多种优化策略，包括构件内部和构件间的并行编译和增量编译等，以实现在各种计算环境下的高效构建，特别是资源受限的设备上。
+（5）有效的构件包管理:
+Ruxgo 将实现 RuxOS 主干构件和功能构件的远程仓库存储，以便于按需下载和集成，而非在本地存储整个代码库。远程存储机制允许应用程序只获取所需部分，减少本地存储占用，从而加快 Unikernel 镜像的创建过程。此外，相关构件可在远程独立维护和更新，有助于提高系统整体的构建效率和灵活性。
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/toml_example.html b/guide/toml_example.html
new file mode 100644
index 0000000..dfa26ba
--- /dev/null
+++ b/guide/toml_example.html
@@ -0,0 +1,331 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TOML 文件设计
+Ruxgo 的 TOML 构建描述文件主要包含三个核心组件：Build 组件、Targets 组件和 OS 组件。如下图所示：
+
+ 
+
各个组件的具体功能和配置项描述如下：
+Build 组件：
+定义构建过程中的基本配置，如编译器的类型和应用程序可执行文件的路径。具体包含以下字段：
+-
+
-
+
+compiler: 指定使用的编译器类型。例如，对于 GCC 编译器，此字段值为 “gcc”；对于 Clang 编译器，此字段值为 “clang”。
+ -
+
+app: 指定应用程序可执行文件的路径。
+
通过在 Build 组件中指定适当的编译器，如 GCC 或 Clang，Ruxgo 能够适配不同的开发环境和平台。同时，Build 组件还允许直接指定应用程序的可执行文件路径，以支持预编译的二进制文件的集成和部署。
+Targets 组件：
+定义应用程序的构建目标和相关配置。在 Targets 组件中，每个目标可以是一个库、一个可执行文件或其它类型的构建产物。一个配置文件中可以定义多个应用程序构建目标（Target），每个构建目标都包含以下字段：
+-
+
-
+
+name: 指定目标的名称。对于动态链接库（“dll”）类型的目标，命名需 “lib_” 前缀开头。
+ -
+
+src: 指定目标源代码的根路径。Ruxgo将递归处理该路径下的所有源文件。
+ -
+
+src_only(可选): 列举仅需构建的src中的特定源文件。
+ -
+
+src_exclude(可选): 指定在构建过程中需要排除的 src 中的源文件或目录。
+ -
+
+include_dir: 指定目标源代码所需的头文件路径。
+ -
+
+type: 指定目标的类型，可以是 “static”、“dll”、“object” 或 “exe”，分别代表静态库、动态链接库、中间对象文件和可执行文件。在一个 TOML 文件中，只能有一个 “exe” 目标，但可以有多个其它类型的目标。
+ -
+
+cflags: 指定目标中源文件的编译选项。
+ -
+
+archive(可选): 如果目标类型是 “static”，可以指定一个归档工具来创建静态库，例如：“ar”。
+ -
+
+linker(可选): 指定目标的链接工具。如果该值缺失，则根据compiler选项指定默认值，例如：compiler值为 “gcc”，则目标的默认链接工具为 “gcc”。需要注意的是，当在 RuxOS 上链接所有的库和目标文件时，应当使用 “rust-lld -flavor gnu” 链接工具。
+ -
+
+ldflags: 指定目标中源文件的链接选项。
+ -
+
+deps: 列出当前构建目标所依赖的其它目标，确保依赖关系的正确处理。
+
通过为每个构建目标配置源代码路径、头文件路径、编译选项、链接选项以及依赖关系等，Ruxgo 能够精确地控制它们的构建过程，并确保目标之间的依赖关系得到正确处理。
+OS 组件：
+OS 组件是一个可选组件，用于为应用程序提供在 RuxOS 上运行所需的配置和环境。OS 组件包含以下几个关键字段：
+-
+
-
+
+name: 指定操作系统的名称，用于区分不同的操作系统环境配置。
+ -
+
+services: 列出操作系统需要提供的服务，以支持特定功能或应用需求。
+ -
+
+ulib: 指定用户库，例如：“ruxlibc” 或 “ruxmusl”，以便在构建过程中链接。
+
Ruxgo 提供了基于 QEMU 虚拟机的 x86_64、aarch64 或 riscv64 目标平台的通用配置选项，用户可以根据需求在 [os.platform] 中进行配置，具体字段如下：
+-
+
-
+
+name: 指定操作系统在哪个平台上运行，可选项有：“x86_64-qemu-q35”、“aarch64-qemu-virt” 和 “riscv64-qemu-virt”。默认值为：“x86_64-qemu-q35”。
+ -
+
+smp: 指定处理器数量。默认值为：“1”。
+ -
+
+mode: 指定构建模式。默认值为：“release”。
+ -
+
+log: 指定日志级别，可选项有：“trace”、“debug”、“info”、“warn“和“error”。默认值为：“warn”。
+ -
+
+v: 指定 verbose 级别，可选项有：“”、“1”、“2”。默认值为：“”。
+
对于这些依赖于 QEMU 虚拟机的目标平台，可以在 [os.platform.qemu] 中进一步定义 QEMU 的运行时选项。Ruxgo 提供了一些通用的配置字段，具体如下：：
+-
+
-
+
+blk: 指定是否启用 virtio-blk 存储设备。默认值为：“n”。
+ -
+
+net: 指定是否启用 virtio-net 网络设备。默认值为：“n”。
+ -
+
+graphic: 指定是否启用 virtio-gpu 显示设备和图形输出。默认值为：“n”。
+ -
+
+debug: 指定是否启用 gdb 服务，启用后将监听本地 1234 端口。默认值为：“n”。
+ -
+
+disk_img: 指定虚拟磁盘镜像的路径。默认值为：“./disk_img”。
+ -
+
+v9p: 指定是否启用 virtio-9p 设备。默认值为：“n”。
+ -
+
+v9p_path: 指定 virtio-9p 后端的主机路径。默认值为：“./”。
+ -
+
+qemu_log: 指定是否启用 qemu 日志。默认值为：“n”。
+ -
+
+net_dump: 指定是否启用网络包转储。默认值为：“n”。
+ -
+
+net_dev: 指定 qemu 网络设备的后端类型，可选项有：“user“或“tap”。默认值为：“user”。
+ -
+
+ip: 指定虚拟网络设备的 IPv4 地址。默认值为：“10.0.2.15”。
+ -
+
+gw: 指定虚拟网络设备的网关。默认值为：“10.0.2.2”。
+ -
+
+args: 指定命令行参数，以逗号分隔。它用于传递特定的变量，如 argc、argv。默认值为：“”。
+ -
+
+envs: 指定环境变量，键值对之间用逗号分隔。默认值为：“”。
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/guide/why_ruxgo.html b/guide/why_ruxgo.html
new file mode 100644
index 0000000..10a17bf
--- /dev/null
+++ b/guide/why_ruxgo.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ TOML 文件示例
+Ruxgo 有如下三种适用场景:
+-
+
-
+
在本地构建自我开发的应用程序；
+
+ -
+
在 RuxOS 上开发或移植应用程序；
+
+ -
+
在 RuxOS 上直接运行应用程序可执行文件。
+
+
下面将以 sqlite3 为例，分别给出这三种情况下对应的 TOML 文件示例：
+（1）在本地主机（linux平台）构建 Sqlite3:
+[build]
+compiler = "gcc"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "local_sqlite3"
+src = "./"
+src_only = ["main.c"]
+include_dir = "./"
+type = "exe"
+cflags = "-w -g"
+ldflags = ""
+deps = ["libsqlite3"]
+（2）在 RuxOS 上构建 Sqlite3:
+[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "2"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "ruxos_sqlite3"
+src = "./"
+src_only = ["main.c"]
+include_dir = "./"
+type = "exe"
+cflags = "-w -g"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = ["libsqlite3"]
+（3）在 RuxOS 上运行 Sqlite3 可执行文件:
+[build]
+compiler = "gcc"
+app = "your_app_path" # 在这里指定可执行文件路径
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "2"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+args = "" # 在这里指定应用程序所需参数
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/highlight.css b/highlight.css
new file mode 100644
index 0000000..ba57b82
--- /dev/null
+++ b/highlight.css
@@ -0,0 +1,82 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/highlight.js b/highlight.js
new file mode 100644
index 0000000..18d2434
--- /dev/null
+++ b/highlight.js
@@ -0,0 +1,54 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 为什么 Ruxgo
+RuxOS 早期构建过程的局限性
+在 RuxOS 的早期构建实践中，Make 构建工具通过 Makefile 来组织和管理依赖关系和构件层级，如下图所示。在构建开始时，首先需要通过环境变量指定目标架构、目标应用、日志级别以及 Features 等信息，随后通过顶级 Makefile 来启动整体构建流程。其中，build.mk 文件负责完成 OS Unikernel 镜像的构建，而具体的 RuxOS 内核构建、子构件选择、用户库构建则分别由 cargo.mk、features.mk、build_c.mk 和 build_musl.mk来完成。此外，镜像的运行和测试则通过 qemu.mk 和 test.mk 完成。
+
从上述 RuxOS 的构建过程可以看出，随着系统规模的增长和构件数量的增加，Makefile 的配置变得愈加复杂和庞大。每当新增或修改构件时，都可能需要对 Makefile 进行大量修改，这不仅增加了开发者的负担，也降低了项目的可维护性，同时也存在很多的局限性，具体如下：
+（1）缺乏细粒度的构件关系管理：虽然 Make 可以处理基础依赖关系，但并非为解决构件化系统中常见的细粒度依赖问题而设计。在这样的系统中，构件和特性的选择可能高度动态，因此需要更灵活的依赖解决方案。
+（2）缺乏对配置的有效支持：Makefile 本身并不是为处理复杂的配置关系而设计的。当 RuxOS 需要灵活的配置来选择和组合不同构件时，开发者常常不得不依靠环境变量或手动编辑 Makefile，这不仅增加了配置过程的复杂度，还产生了环境隔离问题，导致在不同开发环境下重现构建结果存在一定难度。
+（3）有限的 Rust 生态系统集成：RuxOS 采用 Rust 语言开发，意味着更倾向于与 Cargo 或 Rust 的生态系统无缝集成。然而，Make 与 Cargo 的集成，如通过单独的 cargo.mk 所示，可能引入额外的复杂性，并且缺乏有效的生态系统利用。
+（4）并行构建支持不足：虽然 Make 支持并行构建以加快构建速度，但在复杂的依赖结构下，其并行能力受到限制。例如，构件与构件之间不正确的依赖管理可能导致并行构建出错，从而迫使开发者牺牲构建速度以保证结果的正确性。
+应用程序移植困难及构件化需求
+在 RuxOS 的开发过程中，一个核心目标是实现对广泛类 Unix 应用程序的兼容，旨在通过整合类 Unix 应用生态来扩展 RuxOS 的生态系统。在项目的早期阶段，移植应用程序的一个直接方法是利用应用程序原有的构建工具，来首先生成库文件或中间对象文件，随后将这些文件与 RuxOS 静态库链接，形成最终的 Unikernel 镜像文件。然而，在实际的移植过程以及后期维护、开发过程中，都面临着多重挑战，具体如下：
+（1）应用程序的构件化需求：应用程序的构建通常涵盖了众多功能模块，包括核心功能、辅助功能、测试功能以及平台特定功能等，其中许多功能并非在所有场景下都是必需的。在 RuxOS 上移植这些应用时，由于 RuxOS 可能缺少某些系统库或不支持特定的函数调用，直接移植整个应用程序可能会遇到兼容性问题。
+（2）应用程序的后期维护需求：一些中等规模的软件项目，其 Makefile 也可能包含数千行代码。在将应用移植到 RuxOS 后，为适配 RuxOS 的构建需求，对原有 Makefile 的调整和修改不可避免，从而加大了应用程序后期维护工作的难度。
+（3）应用程序的增量构建需求：在RuxOS上对应用程序进行二次开发或修改时，完整的构建过程可能耗费大量时间，这使得增量构建成为开发过程中的一个必要需求。
+RuxOS构件化管理缺乏
+原有 RuxOS 的开发和部署缺乏有效的构件化管理。例如下图所示，RuxOS 的 Modules 模块包含了主干构件和功能构件。主干构件，如 ruxruntime、ruxhal、ruxconfig 等，构成了 RuxOS 的核心，是系统运行不可或缺的部分。相比之下，功能构件如 ruxtask、ruxfs、ruxdriver 等则根据应用程序的具体需求进行选择，这些模块易于变动且高度可配置。
+
在应用程序构建过程中，开发者首先需要本地下载完整的 RuxOS 代码库，然后基于特定应用的需求，从 Ulib 库、Modules 模块或 Crates 模块中选择必要的构件集合，最终创建 Unikernel 镜像。这一过程在 RuxOS 项目初期或许可行，但随着项目的发展和构件数量的增加，项目的维护难度和本地存储需求也将显著提升。
+ +":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/installation.html b/installation.html
new file mode 100644
index 0000000..6b7bc0e
--- /dev/null
+++ b/installation.html
@@ -0,0 +1,243 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 简介
+Ruxgo 是一个类似于 Cargo 的构建工具, 专用于构建 C/C++ 应用程序, 它只依赖于一个 Toml 文件。
+它也是 RuxOS 的一个配套命令行工具, 其目标是简化 RuxOS 及其上 C/C++ 应用程序的组装构建和管理。
+Ruxgo 官网：https://github.com/syswonder/ruxgo
+Rust 社区：https://crates.io/crates/ruxgo
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/introduction.html b/introduction.html
new file mode 100644
index 0000000..db527df
--- /dev/null
+++ b/introduction.html
@@ -0,0 +1,231 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Ruxgo 安装
+要安装ruxgo可执行文件，您首先需要安装 Rust 和 Cargo。按照Rust安装页面上的说明操作。Ruxgo 目前至少需要 Rust 1.75 版本。
一旦您安装了 Rust，就可以使用以下命令来构建和安装 Ruxgo:
+cargo install ruxgo
+这将自动从crates.io下载并构建 Ruxgo，并将其安装到 Cargo 的全局二进制目录（默认为~/.cargo/bin/）。
发布到 crates.io 的版本将稍微落后于 GitHub 上托管的版本。如果您需要最新版本，您可以自己构建 Ruxgo 的 git 版本：
+cargo install --git https://github.com/syswonder/ruxgo.git ruxgo
+注意:
+如果您在安装时遇到问题，可能需要安装一些构建依赖项，请参考 RuxOS 下的 README.md.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/mark.min.js b/mark.min.js
new file mode 100644
index 0000000..1636231
--- /dev/null
+++ b/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 简介
+Ruxgo 是一个类似于 Cargo 的构建工具, 专用于构建 C/C++ 应用程序, 它只依赖于一个 Toml 文件。
+它也是 RuxOS 的一个配套命令行工具, 其目标是简化 RuxOS 及其上 C/C++ 应用程序的组装构建和管理。
+Ruxgo 官网：https://github.com/syswonder/ruxgo
+Rust 社区：https://crates.io/crates/ruxgo
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/run_apps.html b/run_apps.html
new file mode 100644
index 0000000..9dfe707
--- /dev/null
+++ b/run_apps.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 简介
+Ruxgo 是一个类似于 Cargo 的构建工具, 专用于构建 C/C++ 应用程序, 它只依赖于一个 Toml 文件。
+它也是 RuxOS 的一个配套命令行工具, 其目标是简化 RuxOS 及其上 C/C++ 应用程序的组装构建和管理。
+Ruxgo 官网：https://github.com/syswonder/ruxgo
+Rust 社区：https://crates.io/crates/ruxgo
+Ruxgo 安装
+要安装ruxgo可执行文件，您首先需要安装 Rust 和 Cargo。按照Rust安装页面上的说明操作。Ruxgo 目前至少需要 Rust 1.75 版本。
一旦您安装了 Rust，就可以使用以下命令来构建和安装 Ruxgo:
+cargo install ruxgo
+这将自动从crates.io下载并构建 Ruxgo，并将其安装到 Cargo 的全局二进制目录（默认为~/.cargo/bin/）。
发布到 crates.io 的版本将稍微落后于 GitHub 上托管的版本。如果您需要最新版本，您可以自己构建 Ruxgo 的 git 版本：
+cargo install --git https://github.com/syswonder/ruxgo.git ruxgo
+注意:
+如果您在安装时遇到问题，可能需要安装一些构建依赖项，请参考 RuxOS 下的 README.md.
+Ruxgo 指南
+本节将为您提供有关如何使用 Ruxgo 开发 C/C++ 应用程序的所有信息。
+为什么 Ruxgo
+RuxOS 早期构建过程的局限性
+在 RuxOS 的早期构建实践中，Make 构建工具通过 Makefile 来组织和管理依赖关系和构件层级，如下图所示。在构建开始时，首先需要通过环境变量指定目标架构、目标应用、日志级别以及 Features 等信息，随后通过顶级 Makefile 来启动整体构建流程。其中，build.mk 文件负责完成 OS Unikernel 镜像的构建，而具体的 RuxOS 内核构建、子构件选择、用户库构建则分别由 cargo.mk、features.mk、build_c.mk 和 build_musl.mk来完成。此外，镜像的运行和测试则通过 qemu.mk 和 test.mk 完成。
+
从上述 RuxOS 的构建过程可以看出，随着系统规模的增长和构件数量的增加，Makefile 的配置变得愈加复杂和庞大。每当新增或修改构件时，都可能需要对 Makefile 进行大量修改，这不仅增加了开发者的负担，也降低了项目的可维护性，同时也存在很多的局限性，具体如下：
+（1）缺乏细粒度的构件关系管理：虽然 Make 可以处理基础依赖关系，但并非为解决构件化系统中常见的细粒度依赖问题而设计。在这样的系统中，构件和特性的选择可能高度动态，因此需要更灵活的依赖解决方案。
+（2）缺乏对配置的有效支持：Makefile 本身并不是为处理复杂的配置关系而设计的。当 RuxOS 需要灵活的配置来选择和组合不同构件时，开发者常常不得不依靠环境变量或手动编辑 Makefile，这不仅增加了配置过程的复杂度，还产生了环境隔离问题，导致在不同开发环境下重现构建结果存在一定难度。
+（3）有限的 Rust 生态系统集成：RuxOS 采用 Rust 语言开发，意味着更倾向于与 Cargo 或 Rust 的生态系统无缝集成。然而，Make 与 Cargo 的集成，如通过单独的 cargo.mk 所示，可能引入额外的复杂性，并且缺乏有效的生态系统利用。
+（4）并行构建支持不足：虽然 Make 支持并行构建以加快构建速度，但在复杂的依赖结构下，其并行能力受到限制。例如，构件与构件之间不正确的依赖管理可能导致并行构建出错，从而迫使开发者牺牲构建速度以保证结果的正确性。
+应用程序移植困难及构件化需求
+在 RuxOS 的开发过程中，一个核心目标是实现对广泛类 Unix 应用程序的兼容，旨在通过整合类 Unix 应用生态来扩展 RuxOS 的生态系统。在项目的早期阶段，移植应用程序的一个直接方法是利用应用程序原有的构建工具，来首先生成库文件或中间对象文件，随后将这些文件与 RuxOS 静态库链接，形成最终的 Unikernel 镜像文件。然而，在实际的移植过程以及后期维护、开发过程中，都面临着多重挑战，具体如下：
+（1）应用程序的构件化需求：应用程序的构建通常涵盖了众多功能模块，包括核心功能、辅助功能、测试功能以及平台特定功能等，其中许多功能并非在所有场景下都是必需的。在 RuxOS 上移植这些应用时，由于 RuxOS 可能缺少某些系统库或不支持特定的函数调用，直接移植整个应用程序可能会遇到兼容性问题。
+（2）应用程序的后期维护需求：一些中等规模的软件项目，其 Makefile 也可能包含数千行代码。在将应用移植到 RuxOS 后，为适配 RuxOS 的构建需求，对原有 Makefile 的调整和修改不可避免，从而加大了应用程序后期维护工作的难度。
+（3）应用程序的增量构建需求：在RuxOS上对应用程序进行二次开发或修改时，完整的构建过程可能耗费大量时间，这使得增量构建成为开发过程中的一个必要需求。
+RuxOS构件化管理缺乏
+原有 RuxOS 的开发和部署缺乏有效的构件化管理。例如下图所示，RuxOS 的 Modules 模块包含了主干构件和功能构件。主干构件，如 ruxruntime、ruxhal、ruxconfig 等，构成了 RuxOS 的核心，是系统运行不可或缺的部分。相比之下，功能构件如 ruxtask、ruxfs、ruxdriver 等则根据应用程序的具体需求进行选择，这些模块易于变动且高度可配置。
+
在应用程序构建过程中，开发者首先需要本地下载完整的 RuxOS 代码库，然后基于特定应用的需求，从 Ulib 库、Modules 模块或 Crates 模块中选择必要的构件集合，最终创建 Unikernel 镜像。这一过程在 RuxOS 项目初期或许可行，但随着项目的发展和构件数量的增加，项目的维护难度和本地存储需求也将显著提升。
+Ruxgo 设计目标
+Ruxgo 旨在为 RuxOS 提供一个构件化支持、高性能、用户友好且生态完善的构建系统。其开发专注于满足 RuxOS 的组装构建需求，同时也支持广泛的类 Unix 系统及 Windows 系统上基于 C/C++ 开发的应用程序。下图是改用 Ruxgo 构建应用程序的设计示意，整个构建描述只需要一个 Toml 文件：
+
Ruxgo 的具体设计目标包括：
+（1）对 RuxOS 的构件化支持：
+Ruxgo 将提供更细粒度的构件和依赖管理能力，支持复杂配置的灵活性，减少手动干预。通过自动化构建流程，Ruxgo 将能够根据应用需求自动选择和配置所需组件，从而提高构建过程的效率。
+（2）对应用程序的构件化支持：
+为了应对应用程序在开发和移植过程中的挑战，Ruxgo 将支持应用程序的功能分解与组装。它将允许应用程序仅包含对于在 RuxOS 上运行所必需的功能模块，同时提供必要的接口来适配和集成系统库和函数调用，确保应用程序的兼容性和性能。
+（3）简洁明了的构建描述：
+Ruxgo 的设计理念核心在于提升用户体验，旨在通过简洁明了的构建描述文件和易于理解的 API 接口，减少软件开发人员在构建过程中的负担，从而降低学习曲线。这样，软件开发人员能够更多地专注于源代码的编写和创新，而非耗费大量时间和精力在理解和使用构建工具上。
+（4）高性能的构建:
+Ruxgo 旨在最小化自身的构建系统开销，以实现快速的响应。同时采用多种优化策略，包括构件内部和构件间的并行编译和增量编译等，以实现在各种计算环境下的高效构建，特别是资源受限的设备上。
+（5）有效的构件包管理:
+Ruxgo 将实现 RuxOS 主干构件和功能构件的远程仓库存储，以便于按需下载和集成，而非在本地存储整个代码库。远程存储机制允许应用程序只获取所需部分，减少本地存储占用，从而加快 Unikernel 镜像的创建过程。此外，相关构件可在远程独立维护和更新，有助于提高系统整体的构建效率和灵活性。
+构建描述说明
+Ruxgo 选择 TOML 文件格式进行构建描述。这是一个旨在易于阅读和编写的声明性文件格式，特别适用于 RuxOS 的构建配置需求。
+在具体实现方面，Ruxgo 采用 config_<platform>.toml 文件来根据不同的平台配置项目。例如，针对 Linux 平台采用 config_linux.toml 文件，针对 Windows 平台则采用 config_win32.toml 文件。下图是 Ruxgo 的源代码文件组织示意：
+ 
+
TOML 文件设计
+Ruxgo 的 TOML 构建描述文件主要包含三个核心组件：Build 组件、Targets 组件和 OS 组件。如下图所示：
+
+ 
+
各个组件的具体功能和配置项描述如下：
+Build 组件：
+定义构建过程中的基本配置，如编译器的类型和应用程序可执行文件的路径。具体包含以下字段：
+-
+
-
+
+compiler: 指定使用的编译器类型。例如，对于 GCC 编译器，此字段值为 “gcc”；对于 Clang 编译器，此字段值为 “clang”。
+ -
+
+app: 指定应用程序可执行文件的路径。
+
通过在 Build 组件中指定适当的编译器，如 GCC 或 Clang，Ruxgo 能够适配不同的开发环境和平台。同时，Build 组件还允许直接指定应用程序的可执行文件路径，以支持预编译的二进制文件的集成和部署。
+Targets 组件：
+定义应用程序的构建目标和相关配置。在 Targets 组件中，每个目标可以是一个库、一个可执行文件或其它类型的构建产物。一个配置文件中可以定义多个应用程序构建目标（Target），每个构建目标都包含以下字段：
+-
+
-
+
+name: 指定目标的名称。对于动态链接库（“dll”）类型的目标，命名需 “lib_” 前缀开头。
+ -
+
+src: 指定目标源代码的根路径。Ruxgo将递归处理该路径下的所有源文件。
+ -
+
+src_only(可选): 列举仅需构建的src中的特定源文件。
+ -
+
+src_exclude(可选): 指定在构建过程中需要排除的 src 中的源文件或目录。
+ -
+
+include_dir: 指定目标源代码所需的头文件路径。
+ -
+
+type: 指定目标的类型，可以是 “static”、“dll”、“object” 或 “exe”，分别代表静态库、动态链接库、中间对象文件和可执行文件。在一个 TOML 文件中，只能有一个 “exe” 目标，但可以有多个其它类型的目标。
+ -
+
+cflags: 指定目标中源文件的编译选项。
+ -
+
+archive(可选): 如果目标类型是 “static”，可以指定一个归档工具来创建静态库，例如：“ar”。
+ -
+
+linker(可选): 指定目标的链接工具。如果该值缺失，则根据compiler选项指定默认值，例如：compiler值为 “gcc”，则目标的默认链接工具为 “gcc”。需要注意的是，当在 RuxOS 上链接所有的库和目标文件时，应当使用 “rust-lld -flavor gnu” 链接工具。
+ -
+
+ldflags: 指定目标中源文件的链接选项。
+ -
+
+deps: 列出当前构建目标所依赖的其它目标，确保依赖关系的正确处理。
+
通过为每个构建目标配置源代码路径、头文件路径、编译选项、链接选项以及依赖关系等，Ruxgo 能够精确地控制它们的构建过程，并确保目标之间的依赖关系得到正确处理。
+OS 组件：
+OS 组件是一个可选组件，用于为应用程序提供在 RuxOS 上运行所需的配置和环境。OS 组件包含以下几个关键字段：
+-
+
-
+
+name: 指定操作系统的名称，用于区分不同的操作系统环境配置。
+ -
+
+services: 列出操作系统需要提供的服务，以支持特定功能或应用需求。
+ -
+
+ulib: 指定用户库，例如：“ruxlibc” 或 “ruxmusl”，以便在构建过程中链接。
+
Ruxgo 提供了基于 QEMU 虚拟机的 x86_64、aarch64 或 riscv64 目标平台的通用配置选项，用户可以根据需求在 [os.platform] 中进行配置，具体字段如下：
+-
+
-
+
+name: 指定操作系统在哪个平台上运行，可选项有：“x86_64-qemu-q35”、“aarch64-qemu-virt” 和 “riscv64-qemu-virt”。默认值为：“x86_64-qemu-q35”。
+ -
+
+smp: 指定处理器数量。默认值为：“1”。
+ -
+
+mode: 指定构建模式。默认值为：“release”。
+ -
+
+log: 指定日志级别，可选项有：“trace”、“debug”、“info”、“warn“和“error”。默认值为：“warn”。
+ -
+
+v: 指定 verbose 级别，可选项有：“”、“1”、“2”。默认值为：“”。
+
对于这些依赖于 QEMU 虚拟机的目标平台，可以在 [os.platform.qemu] 中进一步定义 QEMU 的运行时选项。Ruxgo 提供了一些通用的配置字段，具体如下：：
+-
+
-
+
+blk: 指定是否启用 virtio-blk 存储设备。默认值为：“n”。
+ -
+
+net: 指定是否启用 virtio-net 网络设备。默认值为：“n”。
+ -
+
+graphic: 指定是否启用 virtio-gpu 显示设备和图形输出。默认值为：“n”。
+ -
+
+debug: 指定是否启用 gdb 服务，启用后将监听本地 1234 端口。默认值为：“n”。
+ -
+
+disk_img: 指定虚拟磁盘镜像的路径。默认值为：“./disk_img”。
+ -
+
+v9p: 指定是否启用 virtio-9p 设备。默认值为：“n”。
+ -
+
+v9p_path: 指定 virtio-9p 后端的主机路径。默认值为：“./”。
+ -
+
+qemu_log: 指定是否启用 qemu 日志。默认值为：“n”。
+ -
+
+net_dump: 指定是否启用网络包转储。默认值为：“n”。
+ -
+
+net_dev: 指定 qemu 网络设备的后端类型，可选项有：“user“或“tap”。默认值为：“user”。
+ -
+
+ip: 指定虚拟网络设备的 IPv4 地址。默认值为：“10.0.2.15”。
+ -
+
+gw: 指定虚拟网络设备的网关。默认值为：“10.0.2.2”。
+ -
+
+args: 指定命令行参数，以逗号分隔。它用于传递特定的变量，如 argc、argv。默认值为：“”。
+ -
+
+envs: 指定环境变量，键值对之间用逗号分隔。默认值为：“”。
+
TOML 文件示例
+Ruxgo 有如下三种适用场景:
+-
+
-
+
在本地构建自我开发的应用程序；
+
+ -
+
在 RuxOS 上开发或移植应用程序；
+
+ -
+
在 RuxOS 上直接运行应用程序可执行文件。
+
+
下面将以 sqlite3 为例，分别给出这三种情况下对应的 TOML 文件示例：
+（1）在本地主机（linux平台）构建 Sqlite3:
+[build]
+compiler = "gcc"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "local_sqlite3"
+src = "./"
+src_only = ["main.c"]
+include_dir = "./"
+type = "exe"
+cflags = "-w -g"
+ldflags = ""
+deps = ["libsqlite3"]
+（2）在 RuxOS 上构建 Sqlite3:
+[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "2"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "ruxos_sqlite3"
+src = "./"
+src_only = ["main.c"]
+include_dir = "./"
+type = "exe"
+cflags = "-w -g"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = ["libsqlite3"]
+（3）在 RuxOS 上运行 Sqlite3 可执行文件:
+[build]
+compiler = "gcc"
+app = "your_app_path" # 在这里指定可执行文件路径
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "2"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+args = "" # 在这里指定应用程序所需参数
+构建一个项目
+可以使用 Ruxgo 快速开始一个项目。首先，确保您的系统上已安装 ruxgo。如果尚未安装，请参考 Ruxgo 安装 。
+之后使用如下命令初始化一个 C 项目：
+ruxgo init my_project --c
+初始化完成后，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+如果您想在 RuxOS 上运行，将 my_project 下的config_<platform>.toml文件修改为如下:
[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = []
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+mode = "release"
+log = "info"
+
+[os.platform.qemu]
+graphic = "n"
+
+[[targets]]
+name = "main"
+src = "./src/"
+include_dir = "./src/include/"
+type = "exe"
+cflags = "-g -Wall -Wextra"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = []
+之后将 my_project 复制到 ruxos/apps/c 目录下，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+Ruxgo 命令
+参数信息：
+A Cargo-like build tool for building C and C++ applications
+
+Usage: ruxgo [OPTIONS] [CHOICES]... [COMMAND]
+
+Commands:
+ init Initialize a new project Defaults to C++ if no language is specified
+ pkg Package management
+ config Configuration settings
+ help Print this message or the help of the given subcommand(s)
+
+Arguments:
+ [CHOICES]... Choose which parts to delete
+
+Options:
+ -b, --build Build your project
+ -c, --clean Clean the obj and bin intermediates
+ -r, --run Run the executable
+ --path <PATH> Path argument to pass to switch to the specified directory
+ --bin-args=<BIN_ARGS>... Arguments to pass to the executable when running
+ --gen-cc Generate compile_commands.json
+ --gen-vsc Generate .vscode/c_cpp_properties.json
+ -h, --help Print help
+ -V, --version Print version
+通用命令
+-
+
- + + +
- + + +
- + + +
ruxgo init
+当您开始一个新项目时，通常需要一些基本的框架设置。ruxgo 提供了 init 命令来帮助您快速开始一个新的 C 或 C++ 项目。
使用方式
+要初始化一个新项目，使用以下命令：
+ruxgo init <项目名称> [--c] [--cpp]
+-
+
<项目名称>: 指定新项目的名称。
+--c: 初始化一个 C 语言项目。
+--cpp: 初始化一个 C++ 语言项目。
+
注意：--c 和 --cpp 选项不能同时使用。如果都不指定，则默认创建一个 C++ 项目。
命令行为
+当运行 ruxgo init 命令后，将会在当前目录下创建一个新的项目目录，其中包括以下内容：
<项目名称>/
+├── src/
+│ ├── main.c 或 main.cpp
+│ └── include/
+├── .gitignore
+├── README.md
+├── LICENSE
+└── config_<platform>.toml
+-
+
src/：包含所有源代码文件和配置文件。
+src/include：用于存放头文件。
+.gitignore：用于指定 git 忽略的文件和目录。
+README.md和LICENSE：项目的基本文档。
+config_<platform>.toml：项目的配置文件，根据运行平台的不同而变化（例如config_linux.toml或config_win32.toml）。
+
示例
+-
+
-
+
初始化一个名为 “my_project” 的 C++ 项目：
+
+ruxgo init my_project --cpp +
+ -
+
初始化一个名为 “my_project” 的 C 项目：
+
+ruxgo init my_project --c +
+
提示
+-
+
- 使用
--help选项可以查看更多命令帮助。
+ - 当项目目录已经存在时，
ruxgo init将不会继续执行，并显示错误信息。
+ - 通过修改
config_<platform>.toml文件，您可以自定义编译器选项和其他构建设置。
+
ruxgo pkg
+ruxgo pkg 命令用于管理软件包，包括列出、拉取、更新和清理软件包等。
使用方式
+要使用 ruxgo pkg 命令，您可以执行以下操作：
ruxgo pkg [选项]
+可选项如下：
+-
+
-l, --list: 列出远程仓库中可用的软件包。
+-p, --pull <PKG_NAME>: 从远程仓库拉取特定软件包。
+-r, --run <APP_BIN>: 运行特定的应用程序二进制文件。
+-u, --update <PKG_NAME>: 更新特定软件包。
+-c, --clean <PKG_NAME>: 清理特定软件包。
+--clean-all: 清理所有软件包。
+-h, --help: 打印帮助信息。
+
下载的文件保存在 ruxgo_pkg/ 目录中，具体内容如下：
-
+
app-bin/: 存放 app 可执行文件及其对应脚本。
+ruxos/: ruxos 存储位置。
+rux-*/: app 源码存储位置。
+cache/: 存放 packages 信息的缓存。
+
示例
+-
+
-
+
列出所有可用的软件包：
+
+ruxgo pkg --list +
+ -
+
从远程仓库拉取名为 “example_pkg” 的软件包：
+
+ruxgo pkg --pull example_pkg +
+ -
+
更新名为 “example_pkg” 的软件包：
+
+ruxgo pkg --update example_pkg +
+ -
+
清理名为 “example_pkg” 的软件包：
+
+ruxgo pkg --clean example_pkg +
+ -
+
清理所有软件包：
+
+ruxgo pkg --clean-all +
+
提示
+-
+
- 使用
--help选项可以查看更多命令帮助。
+ - 确保在执行任何软件包管理操作之前，您的系统已连接到互联网。 +
ruxgo help
+ruxgo help 命令用于显示 ruxgo 工具的帮助信息，包括其各个子命令的详细说明。
使用方式
+要获取 ruxgo 工具或其任一子命令的帮助信息，您可以执行以下操作：
ruxgo help [子命令]
+示例
+-
+
-
+
显示
+ruxgo的总体帮助信息：
+ruxgo help +
+ -
+
查看关于
+init命令的详细帮助：
+ruxgo help init +
+ -
+
查看关于
+pkg命令的详细帮助：
+ruxgo help pkg +
+
提示
+-
+
- 不带任何子命令时，
ruxgo help将显示ruxgo工具的总体帮助信息，包括所有可用的命令和选项。
+ - 当指定一个子命令时，如
ruxgo help init，将显示该特定子命令的详细帮助信息。
+
构建命令
+ +ruxgo -b
+ruxgo -b 命令用于构建您的项目，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要构建当前项目，您可以执行以下操作：
+ruxgo -b [--path <路径>] [--gen-cc] [--gen-vsc]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行构建操作。如果不提供，则默认在当前目录下执行。
+--gen-cc: 生成compile_commands.json文件，它包含了编译项目的所有命令。
+--gen-vsc: 生成 Visual Studio Code 的配置文件.vscode/c_cpp_properties.json，它包含了项目的编译器配置和头文件路径。
+
命令行为
+当执行 ruxgo -b 命令后，将会在当前目录下创建一个名为 ruxgo_bld/ 的构建目录，包括以下内容：
ruxgo_bld/
+├── bin/
+├── obj_linux/ 或 obj_win32/
+├── target/
+├── *.hash
+├── compile_commands.json (如果启用了gen_cc)
+├── .vscode/c_cpp_properties.json (如果启用了gen_vsc)
+└── ruxmusl/ (如果使用了ruxmusl用户库)
+-
+
bin/： 存放构建过程中生成的静态库、动态库、目标文件或可执行文件 。
+obj_linux/obj_win32： 存放编译源码生成的中间对象文件 （ *.o ）。
+target： 存放构建 ruxos 后生成的 target 文件。
+*.hash： 存放构建过程中生成的 hash 文件，用来实现增量构建。
+compile_commands.json： 存放构建过程中的所有编译命令，如果启用了 gen_cc。
+.vscode/c_cpp_properties.json： 存放项目的 vscode 配置，如果启用了 gen_vsc。
+ruxmusl/： 存放构建 ruxmusl 后生成的中间文件及静态库，如果使用了 ruxmusl 。
+
ruxgo -r
+ruxgo -r 命令用于运行项目中的可执行文件，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要运行构建的项目，您可以执行以下操作：
+ruxgo -r [--path <路径>] [--bin-args <参数列表>]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行运行操作。如果不提供，则默认在当前目录下执行。
+--bin-args=<参数列表>: 提供一系列运行时参数传递给项目的可执行文件，参数跟在=后面且以逗号分隔。
+
命令行为
+执行 ruxgo -r 命令后，将会运行 bin/ 目录下的可执行文件。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
ruxgo -c
+ruxgo -c 命令用于清理项目，需确保当前目录下存在 config_<platform>.toml。
使用方式
+要清理构建的项目，您可以执行以下操作：
+ruxgo -c [--path <路径>]
+-
+
--path <路径>: 指定一个特定的目录（需存在config_<platform>.toml）来执行清理操作。如果不提供，则默认在当前目录下执行。
+
命令行为
+执行 ruxgo -c 命令后，ruxgo 提供了一个多选界面，让用户选择要清理的过程文件，按下 Esc 键则退出当前命令，按下空格（Space）键则选中要清理的项目。具体内容如下：
-
+
All/： 删除项目所有内容。
+App_bins/： 删除构建的 app 可执行文件及其相关库。
+Obj/： 删除编译源码生成的中间对象文件（*.o）。
+OS/： 删除 ruxos 的构建目录。
+Ulib/： 删除 Ulib 的构建内容，如ruxlibc或ruxmusl。
+
需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
运行不同的app
+在ruxgo/apps/目录下放置了所有经过测试的 Toml 文件。
-
+
-
+
如果你正在开发自己的应用程序并希望构建和运行它，你可以参考模板写一个 Toml 文件，然后把它放在你的项目目录下，即可使用 ruxgo 来构建和运行它。
+
+ -
+
如果你想在 RuxOS 上构建一个已经支持的应用程序，你需要将
+config_linux.toml从ruxgo/apps/<name>/ruxos复制到ruxos/apps/c/<name>，然后参考说明使用 ruxgo 构建并运行它。
+ -
+
如果你有自己的应用程序可执行文件，并希望在 RuxOS 上运行它，你可以参考
+ruxgo/apps/loader_app下的模板并配置你自己的 Toml 文件，然后使用 ruxgo 来构建和运行它。
+
注: 有关详细信息，请参阅每个 app 目录下的 README.md。以下应用程序已获支持:
+-
+
- +redis +
- +sqlite3 +
- +iperf +
- +loader_app +
- +helloworld +
- +memtest +
- +httpclient +
- +httpserver +
- +nginx +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/searcher.js b/searcher.js
new file mode 100644
index 0000000..dc03e0a
--- /dev/null
+++ b/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 运行不同的app
+在ruxgo/apps/目录下放置了所有经过测试的 Toml 文件。
-
+
-
+
如果你正在开发自己的应用程序并希望构建和运行它，你可以参考模板写一个 Toml 文件，然后把它放在你的项目目录下，即可使用 ruxgo 来构建和运行它。
+
+ -
+
如果你想在 RuxOS 上构建一个已经支持的应用程序，你需要将
+config_linux.toml从ruxgo/apps/<name>/ruxos复制到ruxos/apps/c/<name>，然后参考说明使用 ruxgo 构建并运行它。
+ -
+
如果你有自己的应用程序可执行文件，并希望在 RuxOS 上运行它，你可以参考
+ruxgo/apps/loader_app下的模板并配置你自己的 Toml 文件，然后使用 ruxgo 来构建和运行它。
+
注: 有关详细信息，请参阅每个 app 目录下的 README.md。以下应用程序已获支持:
+-
+
- +redis +
- +sqlite3 +
- +iperf +
- +loader_app +
- +helloworld +
- +memtest +
- +httpclient +
- +httpserver +
- +nginx +