fix: fix project config and documentations

Signed-off-by: Haobo Gu <[email protected]>

.vscode/settings.json

@@ -8,7 +8,7 @@
         "--message-format=json"
     ],
     "rust-analyzer.linkedProjects": [
-        "./rmk/Cargo.toml"
+        "rmk/Cargo.toml"
     ],
     "rust-analyzer.showUnlinkedFileNotification": false,
 }

Cargo.toml

@@ -5,7 +5,7 @@ members = [
     "boards/rp2040",
     # Uncomment to choose one chip you want to use
     "boards/stm32h7",
-    #"boards/stm32f4"
+    # "boards/stm32f4"
 ]
 default-members = ["boards/stm32h7", "rmk"]
 

boards/stm32f4/Cargo.toml

@@ -55,3 +55,5 @@ panic-probe = {version = "0.3", features = ["print-defmt"] }
 name = "rmk-stm32f4"
 test = false
 bench = false
+
+[workspace]

rmk/src/layout_macro.rs

@@ -1,26 +1,28 @@
-/// Macro for creating layout of actions
+/// Create a layer in keymap
 #[macro_export]
 macro_rules! layer {
     ([$([$($x: expr), +]), +]) => {
         [$([$($x), +]),+]
     };
 }
 
+/// Create a normal keycode
 #[macro_export]
 macro_rules! k {
     ($k: ident) => {
         $crate::action::KeyAction::Single($crate::action::Action::Key($crate::keycode::KeyCode::$k))
     };
 }
 
+/// Create a normal action
 #[macro_export]
 macro_rules! a {
     ($a: ident) => {
         $crate::action::KeyAction::$a
     };
 }
 
-/// Macro for mouse key action
+/// Create a mouse key action
 #[macro_export]
 macro_rules! mk {
     ($k: ident) => {
@@ -30,7 +32,7 @@ macro_rules! mk {
     };
 }
 
-/// Macro for system control action
+/// Create a control action
 #[macro_export]
 macro_rules! sc {
     ($k: ident) => {
@@ -40,7 +42,7 @@ macro_rules! sc {
     };
 }
 
-/// Macro for consumer control action
+/// Create a consumer control action
 #[macro_export]
 macro_rules! cc {
     ($k: ident) => {
@@ -50,23 +52,23 @@ macro_rules! cc {
     };
 }
 
-/// Macro for layer activate
+/// Create a layer activate action
 #[macro_export]
 macro_rules! mo {
     ($x: literal) => {
         $crate::action::KeyAction::Single($crate::action::Action::LayerOn($x))
     };
 }
 
-/// Macro for layer activate with modifier
+/// Create a layer activate with modifier action
 #[macro_export]
 macro_rules! lm {
     ($x: literal, $m: expr) => {
         $crate::action::KeyAction::WithModifier($crate::action::Action::LayerOn($x), $m)
     };
 }
 
-/// Macro for layer or tap key
+/// Create a layer activate action or tap key(tap/hold)
 #[macro_export]
 macro_rules! lt {
     ($x: literal, $k: ident) => {
@@ -77,23 +79,23 @@ macro_rules! lt {
     };
 }
 
-/// Macro for oneshot layer
+/// Create an oneshot layer key in keymap
 #[macro_export]
 macro_rules! osl {
     ($x: literal) => {
         $crate::action::KeyAction::OneShot($crate::action::Action::LayerOn($x))
     };
 }
 
-/// Macro for layer toggle
+/// Create a layer toggle action
 #[macro_export]
 macro_rules! tg {
     ($x: literal) => {
         $crate::action::KeyAction::Single($crate::action::Action::LayerToggle($x))
     };
 }
 
-/// Macro for layer or tap toggle
+/// Create a layer activate or tap toggle action
 #[macro_export]
 macro_rules! tt {
     ($x: literal) => {

rmk/src/lib.rs

@@ -13,11 +13,10 @@ use embedded_storage::nor_flash::NorFlash;
 use keyboard::Keyboard;
 use keymap::KeyMap;
 use usb::KeyboardUsbDevice;
+use via::process::VialService;
 
-pub use embassy_sync;
 pub use embassy_usb;
 pub use usbd_hid;
-use via::process::VialService;
 
 pub mod action;
 pub mod debounce;