diff --git a/keyboards/typetheory/readme.md b/keyboards/typetheory/readme.md index 9318e79096d..f7b0636ad91 100644 --- a/keyboards/typetheory/readme.md +++ b/keyboards/typetheory/readme.md @@ -1,5 +1,5 @@ -TypeTheory Keyboard -====== +# TypeTheory Keyboard + ![Picture of TypeTheory Keyboard](https://typetheory.co.uk/thumb/front.jpg) The [TypeTheory Keyboard](https://typetheory.co.uk/) is a split ergonomic keyboard inspired by the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) and the Kinesis Advantage2. It uses two Puchi-C microcontrollers, with physical reset buttons. @@ -8,22 +8,21 @@ The [TypeTheory Keyboard](https://typetheory.co.uk/) is a split ergonomic keyboa * Hardware Supported: TypeTheory Keyboard * Hardware Availability: https://typetheory.co.uk - -## Compiling and flashing the firmware -> 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). - -Clone the `qmk_firmware` repository and run this command to compile the firmware with the default layout: +Make example for this keyboard (after setting up your build environment): make typetheory:default -To flash a keyboard half, you must connect it to the computer and reset the microcontroller. To reset, you can either: -1. Press the RESET key on the keyboard, this is RAISE+RIGHT SHIFT on the default layout. -2. With the keyboard unplugged, hold SPACE + B while plugging in the keyboard. -3. Open up the keyboard half, and press the reset button on the Puchi-C board - -Once reset, you can flash the left/right half by using one of these commands respectively: +Flashing example for this keyboard: make typetheory:default:dfu-split-left make typetheory:default:dfu-split-right -Tip: if desired, you can flash different layouts to the left/right side. Then, the entire keyboard will use the 'left' layout when the left side is plugged into the computer, and vice-versa for the right side. Do not attempt to plug in both keyboard halves into the computer at once. +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). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the Puchi-C +* **Keycode in layout**: Press the key mapped to `RESET` (`RAISE`+Right Shift on the default keymap) diff --git a/keyboards/typetheory/rules.mk b/keyboards/typetheory/rules.mk index dcd6530648a..7563fa1a800 100644 --- a/keyboards/typetheory/rules.mk +++ b/keyboards/typetheory/rules.mk @@ -1,14 +1,24 @@ +# MCU name MCU = atmega32u4 -BOOTLOADER = atmel-dfu -SPLIT_KEYBOARD = yes -LTO_ENABLE = yes +# Bootloader selection +BOOTLOADER = atmel-dfu -BOOTMAGIC_ENABLE = yes -MOUSEKEY_ENABLE = no -EXTRAKEY_ENABLE = yes -CONSOLE_ENABLE = yes -COMMAND_ENABLE = yes -NKRO_ENABLE = yes -UNICODE_ENABLE = no -BLUETOOTH_ENABLE = no +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = no # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = yes # Commands for debug and configuration +# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +NKRO_ENABLE = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +BLUETOOTH_ENABLE = no # Enable Bluetooth +AUDIO_ENABLE = no # Audio output +SPLIT_KEYBOARD = yes +LTO_ENABLE = yes