Skip to content

Commit

Permalink
feat: release RMK 0.1.3
Browse files Browse the repository at this point in the history
Signed-off-by: Haobo Gu <[email protected]>
  • Loading branch information
HaoboGu committed Jan 26, 2024
1 parent d62c02a commit dba761d
Show file tree
Hide file tree
Showing 16 changed files with 291 additions and 24 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@

Keyboard firmware for cortex-m, with layer/dynamic keymap/[vial](https://get.vial.today) support, written in Rust.

RMK is under active development, breaking changes may happen. Please check the latest doc or file an issue if you have any problem.

## News

Rmk just released version 0.1.0, migrate to [Embassy](https://github.com/embassy-rs/embassy)! By migrating to Embassy, Rmk now has better async support, more supported MCUs and much easier usages than before. For examples using Embassy, check [`boards`](https://github.com/HaoboGu/rmk/tree/main/boards) folder!
RMK just released version 0.1.0, migrate to [Embassy](https://github.com/embassy-rs/embassy)! By migrating to Embassy, RMK now has better async support, more supported MCUs and much easier usages than before. For examples using Embassy, check [`boards`](https://github.com/HaoboGu/rmk/tree/main/boards) folder!

## Prerequisites

This crate requires Rust 1.75 and up. `openocd`(stm32) or `probe-rs`(stm32/rp2040) is used for flashing & debugging.

## Usage

NOTE: RMK
You can build your own keyboard firmware using RMK or try built-in firmware example for stm32h7 & rp2040.

### Build your own firmware
Expand Down Expand Up @@ -93,7 +96,7 @@ A lot of todos at the list, any contributions are welcomed :)
- [ ] cli tools

## License
Rmk is licensed under either of
RMK is licensed under either of

- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
Expand Down
68 changes: 66 additions & 2 deletions boards/rp2040/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions boards/rp2040/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rmk-rp2040"
version = "0.1.2"
version = "0.1.3"
authors = ["Haobo Gu <[email protected]>"]
description = "Keyboard firmware written in Rust"
homepage = "https://github.com/haobogu/rmk"
Expand All @@ -10,7 +10,7 @@ edition = "2021"
license = "MIT OR Apache-2.0"

[dependencies]
rmk = { version = "0.1.2", path = "../../rmk" }
rmk = { version = "0.1.3", path = "../../rmk" }
embassy-time = { version = "0.3", features = ["defmt"] }
embassy-rp = { version = "0.1", features = [
"defmt",
Expand All @@ -37,6 +37,11 @@ panic-probe = { version = "0.3", features = ["print-defmt"] }
# on macOS with Apple Silicon at least
# default = ["rp-pico/disable-intrinsics"]

[build-dependencies]
xz2 = "0.1.7"
json = "0.12"
const-gen = "1.6"

[[bin]]
name = "rmk-rp2040"
test = false
Expand Down
2 changes: 1 addition & 1 deletion boards/rp2040/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const FLASH_SIZE: usize = 2 * 1024 * 1024;

#[embassy_executor::main]
async fn main(_spawner: Spawner) {
info!("Rmk start!");
info!("RMK start!");
// Initialize peripherals
let p = embassy_rp::init(Default::default());

Expand Down
43 changes: 43 additions & 0 deletions boards/rp2040/vial.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name": "HID Keyboard",
"vendorId": "0x4C4B",
"productId": "0x4643",
"lighting": "none",
"matrix": {
"rows": 4,
"cols": 3
},
"layouts": {
"labels": [
[
"label",
"label2"
]
],
"keymap": [
[
"0,0",
"0,1",
"0,2"
],
[
"1,0",
"1,1",
"1,2"
],
[
"2,0",
"2,1",
"2,2"
],
[
{
"y": -2,
"x": 4
},
"3,0",
"3,2"
]
]
}
}
74 changes: 72 additions & 2 deletions boards/stm32f4/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit dba761d

Please sign in to comment.