myrddin/codecaster
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the README.

Browse Source 
I updated the README with information about what this project was made
to do and a bit of the information I have currently learned through my
research on how I plan to implement the firmware.
This commit is contained in:
Myrddin Dundragon 2025-04-09 02:31:33 -04:00
parent 4f54f78187
commit 5811f5133b
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -1,4 +1,29 @@
# Codecaster
*Empower Your Typing, Cast Your Spells*
A custom keyboard and its firmware.
The Codecaster is both a custom keyboard and its firmware.
The Codecaster keyboard is the development keyboard that the firmware will
initially officially support. As time moves on this will expand to allow
for more keyboards and eventually other target platforms (microcontrollers).
## Firmware
The firmware is written in Rust. It uses [embedded-hal][HAL] to create
an async abstraction for the MCU this is then combined with our keyboard
model.
[HAL]: https://github.com/rust-embedded/embedded-hal
### Building
### Flashing
## Keyboard
The Codecaster is a 38 key split keyboard. It will have per key RGB and
underlighting. It will have some form of battery meter, LEDs or display
has not been determined yet.
### Platform
The initial target platform (microcontroller) will be the nRF52,
specifically the nice!nano v2. This will allow the Codecaster keyboard
to be wireless.