doc

cube/src/bagua.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/001_bagua.md")]
+
 use embassy_time::Timer;
 
 use crate::{App, CubeRng, RNG};

cube/src/cube_man.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/006_cube_man.md")]
+
 use alloc::{collections::VecDeque, vec::Vec};
 use cube_rand::CubeRng;
 use embassy_time::Timer;
@@ -26,6 +28,12 @@ pub struct CubeManGame {
     waiting_time: u64,
 }
 
+impl Default for CubeManGame {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl CubeManGame {
     pub fn new() -> Self {
         let floors = FloorGen::init();

cube/src/dice.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/002_dice.md")]
+
 use embassy_time::Timer;
 
 use crate::{App, CubeRng, RNG};

cube/src/lib.rs

@@ -37,19 +37,19 @@ use crate::sokoban::Sokoban;
 #[macro_use]
 extern crate alloc;
 
-mod bagua;
-mod battery;
+pub mod bagua;
+pub mod battery;
 pub mod buzzer;
-mod cube_man;
-mod dice;
-mod face;
+pub mod cube_man;
+pub mod dice;
+pub mod face;
 pub mod ledc;
-mod mapping;
-mod maze;
-mod snake;
-mod sokoban;
-mod timers;
-mod ui;
+pub mod mapping;
+pub mod maze;
+pub mod snake;
+pub mod sokoban;
+pub mod timers;
+pub mod ui;
 
 pub static mut RNG: MaybeUninit<Rng> = MaybeUninit::uninit();
 

cube/src/maze.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/005_maze.md")]
+
 use alloc::vec::Vec;
 use embassy_time::Timer;
 use embedded_graphics_core::{

cube/src/snake.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/003_snake.md")]
+
 use alloc::collections::LinkedList;
 use embassy_time::Timer;
 
@@ -20,6 +22,12 @@ pub struct SnakeGame {
     game_over: bool,
 }
 
+impl Default for SnakeGame {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl SnakeGame {
     pub fn new() -> Self {
         let width = 8;

cube/src/sokoban.rs

@@ -26,6 +26,12 @@ pub struct Sokoban {
     game_over: bool,
 }
 
+impl Default for Sokoban {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
 impl Sokoban {
     pub fn new() -> Self {
         let xsb = "

cube/src/timers.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../../rfcs/004_timer.md")]
+
 use alloc::vec::Vec;
 use embassy_time::Timer;
 use embedded_graphics_core::{