minor doc and keymap update
parent
b6cc6108ae
commit
a0f69c9200
|
@ -13,7 +13,7 @@
|
||||||
|
|
||||||
#include "lib/_data-types.h"
|
#include "lib/_data-types.h"
|
||||||
|
|
||||||
#include "key-functions.h" // for a pointer typedef
|
#include "key-functions.h" // for `kbfun_funptr_t`
|
||||||
|
|
||||||
#include "matrix.h" // for number of rows and columns
|
#include "matrix.h" // for number of rows and columns
|
||||||
|
|
||||||
|
|
|
@ -3,14 +3,16 @@
|
||||||
Different layouts are included by modifying a variable in the makefile.
|
Different layouts are included by modifying a variable in the makefile.
|
||||||
|
|
||||||
To write a new one:
|
To write a new one:
|
||||||
* You must implement everything defined in <layout.h>. Take a look at existing
|
* You must implement everything defined in [layout.h] (layout.h). Take a look
|
||||||
layouts.
|
at existing layouts.
|
||||||
* The number of layers must be defined in the layout *.h file.
|
* The number of layers must be defined in the layout *.h file.
|
||||||
* Use `0` for no-operation (unused) keys.
|
* Use `0` for no-operation (unused) keys, and `NULL` for no-operation (unused)
|
||||||
* See <matrix.md> for how the key matrix maps to hardware.
|
functions.
|
||||||
* See </src/lib/_usb/keyboard-usage-page--short-names.h> for available
|
* See [matrix.md] (matrix.md) for how the key matrix maps to hardware.
|
||||||
keycodes.
|
* See [keyboard-usage-page--short-names.h]
|
||||||
* See </src/key-functions.c> for what functions keys can call.
|
(../../lib/_usb/keyboard-usage-page--short-names.h) for available keycodes.
|
||||||
|
* See [key-functions.c] (../../key-functions.c) for what functions keys can
|
||||||
|
call.
|
||||||
|
|
||||||
|
|
||||||
## notes
|
## notes
|
||||||
|
@ -22,7 +24,8 @@ To write a new one:
|
||||||
* The layout matricies could be moved to flash memory (program space, instead
|
* The layout matricies could be moved to flash memory (program space, instead
|
||||||
of data space) in order to save RAM, but that doesn't seem necessary at the
|
of data space) in order to save RAM, but that doesn't seem necessary at the
|
||||||
moment. It would also be slightly slower, though that probably shouldn't
|
moment. It would also be slightly slower, though that probably shouldn't
|
||||||
be a concern.
|
be a concern. It might be necessary (or convenient) if one were trying to
|
||||||
|
implement on-keyboard remaping.
|
||||||
|
|
||||||
|
|
||||||
-------------------------------------------------------------------------------
|
-------------------------------------------------------------------------------
|
||||||
|
|
|
@ -61,20 +61,20 @@ kbfun_funptr_t kb_layout_press[KB_LAYERS][KB_ROWS][KB_COLUMNS] = {
|
||||||
{ // layer 0: default
|
{ // layer 0: default
|
||||||
// right hand
|
// right hand
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
/* 0 */ { f_NOP , f_press , f_press , f_press , f_press , f_press , f_press }, /* 0 */
|
/* 0 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 0 */
|
||||||
/* 1 */ { f_NOP , f_press , f_press , f_press , f_press , f_press , f_press }, /* 1 */
|
/* 1 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 1 */
|
||||||
/* 2 */ { f_NA , f_press , f_press , f_press , f_press , f_press , f_press }, /* 2 */
|
/* 2 */ { f_NA , f_press , f_press , f_press , f_press , f_press , f_press }, /* 2 */
|
||||||
/* 3 */ { f_NOP , f_press , f_press , f_press , f_press , f_press , f_press }, /* 3 */
|
/* 3 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 3 */
|
||||||
/* 4 */ { f_NA , f_NA , f_press , f_press , f_press , f_press , f_NOP }, /* 4 */
|
/* 4 */ { f_NA , f_NA , f_press , f_press , f_press , f_press , f_press }, /* 4 */
|
||||||
/* 5 */ { f_NA , f_press , f_press , f_press , f_press , f_press , f_press }, /* 5 */
|
/* 5 */ { f_NA , f_press , f_press , f_press , f_press , f_press , f_press }, /* 5 */
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
// left hand
|
// left hand
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
/* 6 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NOP }, /* 6 */
|
/* 6 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 6 */
|
||||||
/* 7 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NOP }, /* 7 */
|
/* 7 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 7 */
|
||||||
/* 8 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NA }, /* 8 */
|
/* 8 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NA }, /* 8 */
|
||||||
/* 9 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NOP }, /* 9 */
|
/* 9 */ { f_press , f_press , f_press , f_press , f_press , f_press , f_press }, /* 9 */
|
||||||
/* A */ { f_NOP , f_press , f_press , f_press , f_press , f_NA , f_NA }, /* A */
|
/* A */ { f_press , f_press , f_press , f_press , f_press , f_NA , f_NA }, /* A */
|
||||||
/* B */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NA } /* B */
|
/* B */ { f_press , f_press , f_press , f_press , f_press , f_press , f_NA } /* B */
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
}
|
}
|
||||||
|
@ -84,20 +84,20 @@ kbfun_funptr_t kb_layout_release[KB_LAYERS][KB_ROWS][KB_COLUMNS] = {
|
||||||
{ // layer 0: default
|
{ // layer 0: default
|
||||||
// right hand
|
// right hand
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
/* 0 */ { f_NOP , f_release , f_release , f_release , f_release , f_release , f_release }, /* 0 */
|
/* 0 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 0 */
|
||||||
/* 1 */ { f_NOP , f_release , f_release , f_release , f_release , f_release , f_release }, /* 1 */
|
/* 1 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 1 */
|
||||||
/* 2 */ { f_NA , f_release , f_release , f_release , f_release , f_release , f_release }, /* 2 */
|
/* 2 */ { f_NA , f_release , f_release , f_release , f_release , f_release , f_release }, /* 2 */
|
||||||
/* 3 */ { f_NOP , f_release , f_release , f_release , f_release , f_release , f_release }, /* 3 */
|
/* 3 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 3 */
|
||||||
/* 4 */ { f_NA , f_NA , f_release , f_release , f_release , f_release , f_NOP }, /* 4 */
|
/* 4 */ { f_NA , f_NA , f_release , f_release , f_release , f_release , f_release }, /* 4 */
|
||||||
/* 5 */ { f_NA , f_release , f_release , f_release , f_release , f_release , f_release }, /* 5 */
|
/* 5 */ { f_NA , f_release , f_release , f_release , f_release , f_release , f_release }, /* 5 */
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
// left hand
|
// left hand
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
/* 6 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NOP }, /* 6 */
|
/* 6 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 6 */
|
||||||
/* 7 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NOP }, /* 7 */
|
/* 7 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 7 */
|
||||||
/* 8 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NA }, /* 8 */
|
/* 8 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NA }, /* 8 */
|
||||||
/* 9 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NOP }, /* 9 */
|
/* 9 */ { f_release , f_release , f_release , f_release , f_release , f_release , f_release }, /* 9 */
|
||||||
/* A */ { f_NOP , f_release , f_release , f_release , f_release , f_NA , f_NA }, /* A */
|
/* A */ { f_release , f_release , f_release , f_release , f_release , f_NA , f_NA }, /* A */
|
||||||
/* B */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NA } /* B */
|
/* B */ { f_release , f_release , f_release , f_release , f_release , f_release , f_NA } /* B */
|
||||||
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
/* ---- 0 ---- ---- 1 ---- ---- 2 ---- ---- 3 ---- ---- 4 ---- ---- 5 ---- ---- 6 ---- */
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue