Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.64 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.64 KB
Raw

rumcake-templates

A collection of templates to start building your rumcake firmware.

To get started, install cargo-generate, then generate one of the templates:

cargo generate --git https://github.com/Univa/rumcake-templates

Template updates

rumcake is being developed rapidly, and may introduce a lot of breaking changes to its public API. If you want to update rumcake, please refer to the templates to see how to use it with the most recent version.

Available templates

rumcake-basic-template

Template for a basic keyboard with underglow and a duplex matrix, with the following layout:

image

  • STM32F303CBx
  • USB host communication
  • WS2812 Underglow
  • Duplex Matrix
  • Vial

Note: storage feature is disabled by default to reduce binary size, so Vial and underglow changes will not be saved. See the storage doc for information on how to implement this.

rumcake-split-template

image

Template for a split keyboard with a left and right half, no dongle.

  • nRF52840 on both MCUs
  • Bluetooth host communication
  • Bluetooth used to communicate between both halves