@ -0,0 +1,5 @@ | |||||
# skullY's Clueboard Layout | |||||
This layout is what I (@skullydazed) use on my personal Clueboards. I mostly use it for programming, CAD, and general typing. | |||||
The most notable change from the default layout is putting Ctrl on the Capslock key. I also swap Alt and Cmd because I mostly use a Mac day to day. |
@ -1,4 +1,97 @@ | |||||
Clueboard keyboard firmware | Clueboard keyboard firmware | ||||
====================== | ====================== | ||||
TODO: to be updated. | |||||
DIY/Assembled compact 66% keyboard by [Clueboard](http://clueboard.co). | |||||
For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md). | |||||
## First Time Setup | |||||
Download or clone the whole firmware and navigate to the keyboards/clueboard directory. Once your dev env is setup, you'll be able to generate the default .hex: | |||||
``` | |||||
$ make | |||||
``` | |||||
You will see a lot of output and if everything worked correctly you will see something similar to this: | |||||
``` | |||||
Size after: | |||||
text data bss dec hex filename | |||||
0 19992 0 19992 4e18 clueboard_rev2_default.hex | |||||
``` | |||||
At this point you can press RESET on your Clueboard and flash your keyboard with this command: | |||||
``` | |||||
$ make dfu | |||||
``` | |||||
If you would like to use one of the alternative keymaps, or create your own, see below. | |||||
## Clueboard 1.0 | |||||
If you have a first generation Clueboard (one with a black PCB) you will need to use the revision 1 code. To do so add `SUBPROJECT=rev1` to your make command, like this: | |||||
``` | |||||
$ make SUBPROJECT=rev1 | |||||
``` | |||||
And when flashing your keyboard: | |||||
``` | |||||
$ make SUBPROJECT=rev1 dfu | |||||
``` | |||||
If you are flashing an alternative layout to your rev1, include both `SUBPROJECT=rev1` and `KEYMAP=<keymap>` in your command, for example when flashing max: | |||||
``` | |||||
$ make SUBPROJECT=rev1 KEYMAP=max dfu | |||||
``` | |||||
## Alternate Keymaps | |||||
There are many alternative and user-contributed layouts available in the [keymaps/](keymaps/) directory. To compile and flash an alternative you will want to add `KEYMAP=<keymap>` to your command: | |||||
``` | |||||
$ make KEYMAP=skully | |||||
``` | |||||
And when flashing your keyboard, put `KEYMAP=<keymap>` between "make" and "dfu": | |||||
``` | |||||
$ make KEYMAP=skully dfu | |||||
``` | |||||
### Notable Layouts | |||||
These layouts are notable for one reason or another. If you are looking for ideas or inspiration you should look at these first: | |||||
* [keymaps/default](keymaps/default) - The default Clueboard layout | |||||
* [keymaps/max](keymaps/max) - A maximised layout that makes use of every key and feature of the Clueboard 2.0 PCB. | |||||
* [keymaps/skully](keymaps/skully) - The layout that @skullydazed uses on his own Clueboards. | |||||
## Create Your Own Keymap | |||||
There are a lot of possibilities when creating your own keymap, and the primary documentation for doing that is [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. As a way to get started, here is the procedure I recommend: | |||||
* Copy `[keymaps/default](keymaps/default/)` to `keymaps/<your_layout>`. | |||||
* Compile the firmware (`$ make KEYMAP=<your_layout>`) | |||||
* Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) | |||||
* Make sure everything works like the default keyboard | |||||
* Modify `keymaps/<your_layout>/readme.md` to tell others about your layout. | |||||
* Modify `keymaps/<your_layout>/keymap.c` to reflect your desired layout. | |||||
* Compile your new custom firmware (`$ make KEYMAP=<your_layout>`) | |||||
** If you have warnings you may flash without fixing them, but something may not work right. | |||||
** If you have any errors you must fix them before continuing. | |||||
* Flash the firmware (`$ make KEYMAP=<your_layout> dfu`) | |||||
## Share Your Keymap | |||||
Got your layout dialed in? Please share it with the world so we can benefit from your work! Simply submit a pull request with your layout and we'll include it in the official repository. Please use the following guidelines when putting together your pull request: | |||||
* Include a readme.md that states what your primary keyboard use is, how your layout differs from the default, and highlights anything you think makes your layout particularly great. | |||||
* If your layout requires certain features (EG, RGB underlight or backlighting) ensure you have a Makefile and config.h that reflects that | |||||
* If your layout requires special hardware to be added, please describe that in the readme.md | |||||
TODO: Write up or link quick how-to on creating and submitting a PR. (Pull requests accepted. :) |
@ -0,0 +1,76 @@ | |||||
# MCU name | |||||
#MCU = at90usb1287 | |||||
MCU = atmega32u4 | |||||
# Processor frequency. | |||||
# This will define a symbol, F_CPU, in all source code files equal to the | |||||
# processor frequency in Hz. You can then use this symbol in your source code to | |||||
# calculate timings. Do NOT tack on a 'UL' at the end, this will be done | |||||
# automatically to create a 32-bit value in your source code. | |||||
# | |||||
# This will be an integer division of F_USB below, as it is sourced by | |||||
# F_USB after it has run through any CPU prescalers. Note that this value | |||||
# does not *change* the processor frequency - it should merely be updated to | |||||
# reflect the processor speed set externally so that the code can use accurate | |||||
# software delays. | |||||
F_CPU = 16000000 | |||||
# | |||||
# LUFA specific | |||||
# | |||||
# Target architecture (see library "Board Types" documentation). | |||||
ARCH = AVR8 | |||||
# Input clock frequency. | |||||
# This will define a symbol, F_USB, in all source code files equal to the | |||||
# input clock frequency (before any prescaling is performed) in Hz. This value may | |||||
# differ from F_CPU if prescaling is used on the latter, and is required as the | |||||
# raw input clock is fed directly to the PLL sections of the AVR for high speed | |||||
# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' | |||||
# at the end, this will be done automatically to create a 32-bit value in your | |||||
# source code. | |||||
# | |||||
# If no clock division is performed on the input clock inside the AVR (via the | |||||
# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. | |||||
F_USB = $(F_CPU) | |||||
# Interrupt driven control endpoint task(+60) | |||||
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT | |||||
# Boot Section Size in *bytes* | |||||
# Teensy halfKay 512 | |||||
# Teensy++ halfKay 1024 | |||||
# Atmel DFU loader 4096 | |||||
# LUFA bootloader 4096 | |||||
# USBaspLoader 2048 | |||||
OPT_DEFS += -DBOOTLOADER_SIZE=4096 | |||||
# Build Options | |||||
# change yes to no to disable | |||||
# | |||||
BOOTMAGIC_ENABLE ?= no # Virtual DIP switch configuration(+1000) | |||||
MOUSEKEY_ENABLE ?= yes # Mouse keys(+4700) | |||||
EXTRAKEY_ENABLE ?= yes # Audio control and System control(+450) | |||||
CONSOLE_ENABLE ?= yes # Console for debug(+400) | |||||
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 ?= no # USB Nkey Rollover | |||||
RGBLIGHT_ENABLE ?= yes # Enable keyboard underlight functionality (+4870) | |||||
BACKLIGHT_ENABLE ?= yes # Enable keyboard backlight functionality by default | |||||
MIDI_ENABLE ?= no # MIDI controls | |||||
UNICODE_ENABLE ?= no # Unicode | |||||
BLUETOOTH_ENABLE ?= no # Enable Bluetooth with the Adafruit EZ-Key HID | |||||
AUDIO_ENABLE ?= yes # Audio output on port C6 | |||||
ifndef QUANTUM_DIR | |||||
include ../../Makefile | |||||
endif | |||||
@ -0,0 +1,98 @@ | |||||
#include "cluecard.h" | |||||
#define BL_RED OCR1B | |||||
#define BL_GREEN OCR1A | |||||
#define BL_BLUE OCR1C | |||||
void matrix_init_kb(void) { | |||||
// put your keyboard start-up code here | |||||
// runs once when the firmware starts up | |||||
matrix_init_user(); | |||||
} | |||||
void matrix_scan_kb(void) { | |||||
// put your looping keyboard code here | |||||
// runs every cycle (a lot) | |||||
matrix_scan_user(); | |||||
} | |||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) { | |||||
// put your per-action keyboard code here | |||||
// runs for every action, just before processing by the firmware | |||||
return process_record_user(keycode, record); | |||||
} | |||||
void led_set_kb(uint8_t usb_led) { | |||||
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here | |||||
led_set_user(usb_led); | |||||
} | |||||
void backlight_init_ports(void) | |||||
{ | |||||
// Set B5, B6, and B7 as output | |||||
DDRB |= (1<<7)|(1<<6)|(1<<5); | |||||
// Setup PWM | |||||
ICR1 = 0xFFFF; | |||||
TCCR1A = 0b10101010; | |||||
TCCR1B = 0b00011001; | |||||
BL_RED = 0xFFFF; | |||||
BL_GREEN = 0xFFFF; | |||||
BL_BLUE = 0xFFFF; | |||||
} | |||||
void backlight_set(uint8_t level) | |||||
{ | |||||
// Set the RGB color | |||||
switch (level) | |||||
{ | |||||
case 0: | |||||
// Off | |||||
BL_RED = 0xFFFF; | |||||
BL_GREEN = 0xFFFF; | |||||
BL_BLUE = 0xFFFF; | |||||
break; | |||||
case 1: | |||||
// Red | |||||
BL_RED = 0x0000; | |||||
BL_GREEN = 0xFFFF; | |||||
BL_BLUE = 0xFFFF; | |||||
break; | |||||
case 2: | |||||
// Green | |||||
BL_RED = 0xFFFF; | |||||
BL_GREEN = 0x0000; | |||||
BL_BLUE = 0xFFFF; | |||||
break; | |||||
case 3: | |||||
// Blue | |||||
BL_RED = 0xFFFF; | |||||
BL_GREEN = 0xFFFF; | |||||
BL_BLUE = 0x0000; | |||||
break; | |||||
case 4: | |||||
// Magenta | |||||
BL_RED = 0x4000; | |||||
BL_GREEN = 0x4000; | |||||
BL_BLUE = 0x4000; | |||||
break; | |||||
case 5: | |||||
// Purple | |||||
BL_RED = 0x0000; | |||||
BL_GREEN = 0xFFFF; | |||||
BL_BLUE = 0x0000; | |||||
break; | |||||
case 6: | |||||
// Yellow | |||||
BL_RED = 0x0000; | |||||
BL_GREEN = 0x0000; | |||||
BL_BLUE = 0xFFFF; | |||||
break; | |||||
default: | |||||
xprintf("Unknown level: %d\n", level); | |||||
} | |||||
} |
@ -0,0 +1,22 @@ | |||||
#ifndef CLUECARD_H | |||||
#define CLUECARD_H | |||||
#include "quantum.h" | |||||
// This a shortcut to help you visually see your layout. | |||||
// The first section contains all of the arguements | |||||
// The second converts the arguments into a two-dimensional array | |||||
#define KEYMAP( \ | |||||
k00, k01, k02, \ | |||||
k10, k12, \ | |||||
k20, k21, k22, \ | |||||
k11, \ | |||||
k30, k31, k32 \ | |||||
) { \ | |||||
{ k00, k01, k02, }, \ | |||||
{ k10, k11, k12, }, \ | |||||
{ k20, k21, k22, }, \ | |||||
{ k30, k31, k32, } \ | |||||
} | |||||
#endif |
@ -0,0 +1,167 @@ | |||||
/* | |||||
Copyright 2012 Jun Wako <wakojun@gmail.com> | |||||
This program is free software: you can redistribute it and/or modify | |||||
it under the terms of the GNU General Public License as published by | |||||
the Free Software Foundation, either version 2 of the License, or | |||||
(at your option) any later version. | |||||
This program is distributed in the hope that it will be useful, | |||||
but WITHOUT ANY WARRANTY; without even the implied warranty of | |||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||||
GNU General Public License for more details. | |||||
You should have received a copy of the GNU General Public License | |||||
along with this program. If not, see <http://www.gnu.org/licenses/>. | |||||
*/ | |||||
#ifndef CONFIG_H | |||||
#define CONFIG_H | |||||
#include "config_common.h" | |||||
/* USB Device descriptor parameter */ | |||||
#define VENDOR_ID 0xC1ED | |||||
#define PRODUCT_ID 0x2330 | |||||
#define DEVICE_VER 0x0001 | |||||
#define MANUFACTURER Clueboard | |||||
#define PRODUCT ATMEGA32U4 Firmware Dev Kit | |||||
#define DESCRIPTION A small board to help you hack on QMK. | |||||
/* key matrix size */ | |||||
#define MATRIX_ROWS 4 | |||||
#define MATRIX_COLS 3 | |||||
/* | |||||
* Keyboard Matrix Assignments | |||||
* | |||||
* Change this to how you wired your keyboard | |||||
* COLS: AVR pins used for columns, left to right | |||||
* ROWS: AVR pins used for rows, top to bottom | |||||
* DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) | |||||
* ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) | |||||
* | |||||
*/ | |||||
#define MATRIX_ROW_PINS { F0, F5, F4, B4 } | |||||
#define MATRIX_COL_PINS { F1, F7, F6 } | |||||
#define UNUSED_PINS | |||||
/* COL2ROW or ROW2COL */ | |||||
#define DIODE_DIRECTION ROW2COL | |||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | |||||
#define DEBOUNCING_DELAY 20 | |||||
/* define if matrix has ghost (lacks anti-ghosting diodes) */ | |||||
//#define MATRIX_HAS_GHOST | |||||
/* number of backlight levels */ | |||||
#define BACKLIGHT_LEVELS 6 | |||||
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ | |||||
//#define LOCKING_SUPPORT_ENABLE | |||||
/* Locking resynchronize hack */ | |||||
//#define LOCKING_RESYNC_ENABLE | |||||
/* | |||||
* Force NKRO | |||||
* | |||||
* Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved | |||||
* state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the | |||||
* makefile for this to work.) | |||||
* | |||||
* If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N) | |||||
* until the next keyboard reset. | |||||
* | |||||
* NKRO may prevent your keystrokes from being detected in the BIOS, but it is | |||||
* fully operational during normal computer usage. | |||||
* | |||||
* For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N) | |||||
* or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by | |||||
* bootmagic, NKRO mode will always be enabled until it is toggled again during a | |||||
* power-up. | |||||
* | |||||
*/ | |||||
//#define FORCE_NKRO | |||||
/* | |||||
* Magic Key Options | |||||
* | |||||
* Magic keys are hotkey commands that allow control over firmware functions of | |||||
* the keyboard. They are best used in combination with the HID Listen program, | |||||
* found here: https://www.pjrc.com/teensy/hid_listen.html | |||||
* | |||||
* The options below allow the magic key functionality to be changed. This is | |||||
* useful if your keyboard/keypad is missing keys and you want magic key support. | |||||
* | |||||
*/ | |||||
/* key combination for magic key command */ | |||||
#define IS_COMMAND() ( \ | |||||
keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \ | |||||
) | |||||
/* control how magic key switches layers */ | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false | |||||
/* override magic key keymap */ | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM | |||||
//#define MAGIC_KEY_HELP1 H | |||||
//#define MAGIC_KEY_HELP2 SLASH | |||||
//#define MAGIC_KEY_DEBUG D | |||||
//#define MAGIC_KEY_DEBUG_MATRIX X | |||||
//#define MAGIC_KEY_DEBUG_KBD K | |||||
//#define MAGIC_KEY_DEBUG_MOUSE M | |||||
//#define MAGIC_KEY_VERSION V | |||||
//#define MAGIC_KEY_STATUS S | |||||
//#define MAGIC_KEY_CONSOLE C | |||||
//#define MAGIC_KEY_LAYER0_ALT1 ESC | |||||
//#define MAGIC_KEY_LAYER0_ALT2 GRAVE | |||||
//#define MAGIC_KEY_LAYER0 0 | |||||
//#define MAGIC_KEY_LAYER1 1 | |||||
//#define MAGIC_KEY_LAYER2 2 | |||||
//#define MAGIC_KEY_LAYER3 3 | |||||
//#define MAGIC_KEY_LAYER4 4 | |||||
//#define MAGIC_KEY_LAYER5 5 | |||||
//#define MAGIC_KEY_LAYER6 6 | |||||
//#define MAGIC_KEY_LAYER7 7 | |||||
//#define MAGIC_KEY_LAYER8 8 | |||||
//#define MAGIC_KEY_LAYER9 9 | |||||
//#define MAGIC_KEY_BOOTLOADER PAUSE | |||||
//#define MAGIC_KEY_LOCK CAPS | |||||
//#define MAGIC_KEY_EEPROM E | |||||
//#define MAGIC_KEY_NKRO N | |||||
//#define MAGIC_KEY_SLEEP_LED Z | |||||
/* Underlight configuration | |||||
*/ | |||||
#define RGB_DI_PIN E6 | |||||
//#define RGBLIGHT_TIMER | |||||
#define RGBLED_NUM 4 // Number of LEDs | |||||
#define RGBLIGHT_HUE_STEP 10 | |||||
#define RGBLIGHT_SAT_STEP 17 | |||||
#define RGBLIGHT_VAL_STEP 17 | |||||
/* | |||||
* Feature disable options | |||||
* These options are also useful to firmware size reduction. | |||||
*/ | |||||
/* disable debug print */ | |||||
//#define NO_DEBUG | |||||
/* disable print */ | |||||
//#define NO_PRINT | |||||
/* disable action features */ | |||||
//#define NO_ACTION_LAYER | |||||
//#define NO_ACTION_TAPPING | |||||
//#define NO_ACTION_ONESHOT | |||||
//#define NO_ACTION_MACRO | |||||
//#define NO_ACTION_FUNCTION | |||||
#endif |
@ -0,0 +1,21 @@ | |||||
# Build Options | |||||
# change to "no" to disable the options, or define them in the Makefile in | |||||
# the appropriate keymap folder that will get included automatically | |||||
# | |||||
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) | |||||
MOUSEKEY_ENABLE = no # Mouse keys(+4700) | |||||
EXTRAKEY_ENABLE = no # Audio control and System control(+450) | |||||
CONSOLE_ENABLE = yes # Console for debug(+400) | |||||
COMMAND_ENABLE = yes # Commands for debug and configuration | |||||
NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | |||||
BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality | |||||
MIDI_ENABLE = no # MIDI controls | |||||
AUDIO_ENABLE = yes # Audio output on port C6 | |||||
UNICODE_ENABLE = no # Unicode | |||||
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID | |||||
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight. | |||||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | |||||
ifndef QUANTUM_DIR | |||||
include ../../../../Makefile | |||||
endif |
@ -0,0 +1,8 @@ | |||||
#ifndef CONFIG_USER_H | |||||
#define CONFIG_USER_H | |||||
#include "../../config.h" | |||||
// place overrides here | |||||
#endif |
@ -0,0 +1,63 @@ | |||||
#include "cluecard.h" | |||||
#ifdef AUDIO_ENABLE | |||||
#include "audio.h" | |||||
#endif | |||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||||
[0] = KEYMAP( | |||||
RGB_TOG, RGB_SAI, RGB_VAI, \ | |||||
RGB_HUD, RGB_HUI, \ | |||||
RGB_MOD, RGB_SAD, RGB_VAD, \ | |||||
BL_STEP, \ | |||||
F(0), F(1), F(2) \ | |||||
) | |||||
}; | |||||
#ifdef AUDIO_ENABLE | |||||
float tone_startup[][2] = SONG(STARTUP_SOUND); | |||||
float tone_qwerty[][2] = SONG(QWERTY_SOUND); | |||||
float tone_dvorak[][2] = SONG(DVORAK_SOUND); | |||||
float tone_colemak[][2] = SONG(COLEMAK_SOUND); | |||||
float tone_plover[][2] = SONG(PLOVER_SOUND); | |||||
float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND); | |||||
float music_scale[][2] = SONG(MUSIC_SCALE_SOUND); | |||||
float tone_goodbye[][2] = SONG(GOODBYE_SOUND); | |||||
#endif | |||||
const uint16_t PROGMEM fn_actions[] = { | |||||
[0] = ACTION_FUNCTION(0), | |||||
[1] = ACTION_FUNCTION(1), | |||||
[2] = ACTION_FUNCTION(2) | |||||
}; | |||||
void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) { | |||||
if (record->event.pressed) { | |||||
switch (id) { | |||||
case 0: | |||||
PLAY_NOTE_ARRAY(tone_startup, false, 0); | |||||
break; | |||||
case 1: | |||||
PLAY_NOTE_ARRAY(music_scale, false, 0); | |||||
break; | |||||
case 2: | |||||
PLAY_NOTE_ARRAY(tone_goodbye, false, 0); | |||||
break; | |||||
} | |||||
} | |||||
}; | |||||
void matrix_init_user(void) { | |||||
} | |||||
void matrix_scan_user(void) { | |||||
} | |||||
bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||||
return true; | |||||
} | |||||
void led_set_user(uint8_t usb_led) { | |||||
} |
@ -0,0 +1 @@ | |||||
# The default keymap for cluecard |
@ -0,0 +1,28 @@ | |||||
cluecard keyboard firmware | |||||
====================== | |||||
## Quantum MK Firmware | |||||
For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). | |||||
## Building | |||||
Download or clone the whole firmware and navigate to the keyboards/cluecard folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. | |||||
Depending on which keymap you would like to use, you will have to compile slightly differently. | |||||
### Default | |||||
To build with the default keymap, simply run `make`. | |||||
### Other Keymaps | |||||
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. | |||||
To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: | |||||
``` | |||||
$ make keymap=[default|jack|<name>] | |||||
``` | |||||
Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/` |