Added instructions for Gemini PR support

Added comments and updated the readme to explain how to get Gemini PR to work. Also added a YouTube link showing how to flash the ecosteno.
This commit is contained in:
Nathan Olivares 2021-10-07 21:22:20 -04:00
parent 9185ad707d
commit 9de2f5ff59
3 changed files with 98 additions and 3 deletions

View file

@ -469,8 +469,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
void matrix_init_user(void) {
steno_set_mode(STENO_MODE_BOLT); // STENO_MODE_GEMINI or STENO_MODE_BOLT
//steno_set_mode(STENO_MODE_GEMINI);
// STENO_MODE_GEMINI only works if you remove all references to STENO_MODE_BOLT and then some in QMK.
// This is a QMK problem
// STENO_MODE_GEMINI only works if you remove references to TX Bolt in QMK
// follow ecosteno-geminipr.diff to do this (thanks to dnaq in the Plover discord)
};
layer_state_t layer_state_set_user(layer_state_t state) {

View file

@ -15,4 +15,8 @@ Flashing example for this keyboard:
dfu-util.exe -d 1eaf:0003 -a 2 -D "noll_ecosteno_default.bin"
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). You might still need more info (WIP)
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
[Here's a quick video demonstrating how to flash firmware onto the ecosteno](https://youtu.be/dqeZ40PPEW4)
The steno protocol currently included in this project is TX Bolt. I'm not entirely sure why getting Gemini PR to work isn't as simple as changing steno_set_mode(STENO_MODE_GEMINI) in keymap.c, but for now, if you want to compile ecosteno firmware that works with Gemini PR, you'll need to remove some references to TX Bolt by following ecosteno-geminipr.diff in EcoSteno-Firmware/keyboards/noll/ (thanks to dnaq in the Plover discord).