https://github.com/tombl/picorne
picorne firmware
https://github.com/tombl/picorne
Last synced: 3 months ago
JSON representation
picorne firmware
- Host: GitHub
- URL: https://github.com/tombl/picorne
- Owner: tombl
- Created: 2022-04-12T18:10:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-19T12:35:46.000Z (about 2 years ago)
- Last Synced: 2025-01-18T04:27:33.399Z (5 months ago)
- Language: Rust
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# picorne firmware
Based on the [keyberon](https://github.com/TeXitoi/keyberon) library to create keyboard firmwares.
## Customising the layout
Check out `src/left/layout.rs`.
Just modify the contents of the `layout!` block according to the following documentation.
For a letter key, just write the letter in caps. For a symbol or number, just write it. In the case of special characters, wrap them in single quotes.
Write `n` to do nothing.
Write `t` for a transparent key that goes into the below layer.
Write a number in brackets to transition to that layer.
Write multiple actions in square brackets to do them all.
To reset the pico or boot it into bootsel mode, write `{Custom(Reset)}` or `{Custom(Bootsel)}`.
A layer is enclosed by curly braces, and each row is enclosed by square brackets. Layers are zero-indexed and it defaults to layer 0.
See https://github.com/TeXitoi/keyberon/pull/54 for more details.
## Building
With [rust installed](https://rustup.rs):
```sh
rustup target install thumbv6m-none-eabi
cargo install flip-link
cargo install elf2uf2-rs
# put left into bootsel, then
cargo run --release --bin left
# put right into bootsel, then
cargo run --release --bin right
```
When you change your layout, you only need to rebuild the left's firmware.