doc(kernel): synchronize the features, add README.md

Author: yvt

src/r3_kernel/README.md

@@ -0,0 +1,14 @@
+# r3_kernel
+
+The original kernel of [R3-OS][1].
+
+- Traditional uniprocessor tickless real-time kernel with preemptive scheduling
+
+- Implements a software-based scheduler supporting a customizable number of task priorities (up to 2¹⁵ levels on a 32-bit target, though the implementation is heavily optimized for a smaller number of priorities) and an unlimited number of tasks.
+
+- Provides a scalable kernel timing mechanism with a logarithmic time complexity. This implementation is robust against a large interrupt processing delay.
+
+- The kernel is split into a target-independent portion and a target-specific portion. The target-specific portion (called *a port*) is provided as a separate crate (e.g., [`r3_port_riscv`][2]). An application **combines them using the trait system**.
+
+[1]: https://crates.io/crates/r3
+[2]: https://crates.io/crates/r3_port_riscv

src/r3_kernel/src/lib.md

@@ -1,9 +1,14 @@
 The original kernel of [R3-OS][].
 
 - Traditional uniprocessor tickless real-time kernel with preemptive scheduling
+
+- Implements a software-based scheduler supporting a customizable number of task priorities (up to 2¹⁵ levels on a 32-bit target, though the implementation is heavily optimized for a smaller number of priorities) and an unlimited number of tasks.
+
+- Provides a scalable kernel timing mechanism with a logarithmic time complexity. This implementation is robust against a large interrupt processing delay.
+
 - The kernel is split into a target-independent portion and a target-specific portion. The target-specific portion (called *a port*) is provided as a separate crate. An application **combines them using the trait system**.
 
-[R3-OS]: ../r3/index.html
+[R3-OS]: https://crates.io/crates/r3
 
 <!-- Display a "some Cargo features are disabled" warning in the documentation so that the user can know some items are missing for that reason. But we don't want this message to be displayed when someone is viewing `lib.md` directly, so the actual message is rendered by CSS. -->
 <div class="admonition-follows"></div>

src/r3_kernel/src/lib.rs

@@ -41,27 +41,6 @@
 )]
 #![cfg_attr(not(test), no_std)] // Link `std` only when building a test (`cfg(test)`)
 
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣤⣤⣶⣶⣶⣶⣶⣶⣶⣤⣄⡀⠀⠀⠀⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⣶⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣶⡄⠀⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠀⣠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡆⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠇⠈⠙⠻⣿⠿⠛⠛⠛⠻⠿⢿⣿⣿⠟⢿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠀⠀⠹⣿⣿⣿⣿⣿⣿⡇⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣧⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣾⣽⣿⣿⣿⣿⣿⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⣠⣤⣤⣄⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣷⣄⠀⠀⠀⠀⠰⠶⠶⠤⣤⣤⣤⠀⠀⠛⠸⠻⣿⣿⣿⠃⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠀⣠⣶⣿⣿⣿⣿⣿⣿⣿⣿⣷⣦⣀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣿⣿⣷⠀⠀⠀⣼⡷⠚⠋⠉⠉⠉⠀⢰⣄⣀⣼⣿⣿⠏⠀⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⢠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠓⠂⠀⠒⠠⢄⡀⠀⠀⢿⣿⣿⣿⣧⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⣿⣿⣿⣿⡏⠀⠀⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⢠⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⠛⠉⢉⠏⠉⠁⠀⠒⠠⠄⠀⠀⠉⠀⠘⣿⣿⣿⣿⣿⣦⡀⢀⠠⠄⠀⠀⢤⣤⣤⣿⣿⣿⣿⠀⠀⢀⣤⣤⣄⠀
-// ⠀⠀⠀⠀⠀⣾⣿⣿⣿⣿⣿⣿⣿⣿⡟⠁⠀⠀⢸⣣⠀⠀⠀⠂⠁⠀⠀⠀⠰⠀⠀⠘⣿⣿⣿⣿⣿⣿⣧⣄⠀⠀⠀⠸⣿⣿⣿⣿⣿⣿⠀⠠⠟⠉⢻⣿⡇
-// ⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⠇⠀⠀⠀⢸⠙⠃⢄⠰⠀⠀⠀⠀⠀⡰⠀⠀⠀⠘⣿⣿⣿⣿⣿⣿⣿⣷⣄⠀⠀⠹⣿⣿⣿⣿⣿⣷⣤⣄⣤⣾⣿⠇
-// ⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇⠀⠀⠀⠀⠆⠀⠀⠙⣗⠂⠀⠐⠈⠀⠀⠀⠀⢀⠜⢻⣿⣿⣿⣿⣿⣿⣿⣷⡀⠀⠈⠻⣿⣿⣿⣿⣿⣿⣿⠿⠋⠀
-// ⠀⠀⠀⠀⠀⢻⣿⣿⣿⣿⣿⣿⣿⣿⣧⠀⠀⢠⠂⠁⠀⠀⡞⠀⠍⡉⠀⠀⢀⠒⠒⢹⠀⠀⠀⠙⣿⣿⣿⣿⣿⣿⣿⣷⡀⠀⠀⠀⠉⠉⠉⠉⠉⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠻⣿⣿⣿⣿⣿⣿⣿⣿⣧⣀⠃⠀⠀⠀⡜⠀⡜⢰⠀⠀⠀⢸⠀⠀⠀⡀⠀⠀⠀⠈⢿⣿⣿⣿⣿⣿⣿⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-// ⠀⠀⠀⠀⠀⠀⠀⠈⠻⢿⣿⣿⣿⣿⣿⣿⡇⠀⠀⠀⢀⠃⠀⡇⡄⠀⠀⠀⢸⠀⠀⠀⡇⠀⠀⣀⡀⠈⣿⣿⣿⣿⣿⣿⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-// ⣀⣤⣤⣤⣤⣀⣀⣀⠀⠀⣈⣿⣿⣿⣿⣿⠀⠀⠀⠀⢸⠀⠀⡇⠇⠀⠀⠀⠀⡇⠀⠀⢱⠀⢸⣿⡛⢀⣿⣿⣿⣿⣿⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-// ⠿⠿⠟⠿⠿⠿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⡆⠀⢹⠀⠀⠀⠀⠀⢣⠀⠀⠀⢆⠈⠿⣿⣿⣿⣿⡿⠟⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-// ⠀⢀⠀⠀⠀⠀⠀⠈⠉⠛⠛⠛⠛⠛⠛⠻⠀⠀⠀⠀⠀⠱⠤⠴⡆⠀⠀⠀⠀⠈⢆⣀⣀⣈⠆⠀⠈⠉⠉⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-// ⠉⠉⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠁⠀⠒⠒⠂⠈⠀⠀⠑⠤⠤⠀⠀⠤⠜⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
-
 // `array_item_from_fn!` requires `MaybeUninit`.
 #[doc(hidden)]
 pub extern crate core;