summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuillaume Pinot <texitoi@texitoi.eu>2020-08-18 22:54:38 +0200
committerGuillaume Pinot <texitoi@texitoi.eu>2020-08-18 22:54:38 +0200
commit190ef7ea24054aa297d50b6239a6dff07da1c002 (patch)
treec49a1f57edba2e42372c669b673b5cfe1ba9aa19
parent99422b0144d63f7ceda997056fa94271b3446862 (diff)
Compiling and flashing in the README
-rw-r--r--README.md34
1 files changed, 31 insertions, 3 deletions
diff --git a/README.md b/README.md
index f1dcfcf..8080b49 100644
--- a/README.md
+++ b/README.md
@@ -4,15 +4,43 @@ KeySeeBee is a split ergo keyboard. It is only 2 PCB (so the name) with (almost)
The firmware is [Keyberon](https://github.com/TeXitoi/keyberon), a pure rust firmware.
-Features:
+## Features
+
* 44 keys, using Cherry MX or Kailh choc switches, only 1U keycaps;
* USB-C connector on the 2 sides
* TRRS cable for connecting the 2 halves (for power and UART communication between the 2 halves);
- * 2 STM32F072 MCU;
+ * 2 STM32F072 MCU, with hardware USB bootloader and crystal less USB;
* Only onboard SMD component (except for the switches and TRRS connector).
-Inspiration:
+## Inspiration
+
* [Plaid](https://github.com/hsgw/plaid) for "show the components"
* [GergoPlex](https://www.gboards.ca/product/gergoplex) for "just a keyboard" and "only a PCB with SMD components"
* [Lily58](https://github.com/kata0510/Lily58) for the thumb cluster
* [Kyria](https://blog.splitkb.com/blog/introducing-the-kyria) for "don't be affraid of pinky stagger"
+
+## Compiling and flashing
+
+Install the complete toolchain and utils:
+
+```shell
+curl https://sh.rustup.rs -sSf | sh
+rustup target add thumbv6m-none-eabi
+rustup component add llvm-tools-preview
+cargo install cargo-binutils
+sudo apt-get install dfu-util
+```
+
+Compile:
+
+```shell
+cd firmware
+cargo objcopy --bin keyseebee --release -- -O binary keyseebee.bin
+```
+
+To flash using dfu-util, first put the board in dfu mode by pressing
+BOOT, pressing and releasing RESET and releasing BOOT. Then:
+
+```shell
+dfu-util -d 0483:df11 -a 0 -s 0x08000000:force:unprotect:leave -D keyseebee.bin
+```