mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-22 00:16:41 +06:00
Code Issues Packages Projects Releases Wiki Activity

Stub out community layout directory structure (#22545)

Browse Source
This commit is contained in:
Joel Challis 2023-11-26 18:31:20 +00:00 committed by GitHub
parent 65b5969ed5
commit 4908d4b1ca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
88 changed files with 241 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
layouts/community/60_abnt2/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_abnt2
LAYOUT_60_abnt2

66
layouts/community/60_ansi/readme.md
View File

@ -1,67 +1,3 @@
# 60_ansi
This is the standard 60% ANSI keyboard layout.
## Requirements
### 1. Layout defined
A keyboard's `.h` file needs to have `LAYOUT_60_ansi` defined
```c
#define LAYOUT_60_ansi( \
K36, K37, K46, K47, K56, K57, K66, K67, K76, K77, K06, K07, K17, K27, \
K34, K35, K44, K45, K54, K55, K64, K65, K75, K05, K15, K16, K25, K24, \
K32, K33, K43, K52, K53, K63, K73, K74, K03, K04, K13, K14, K23, \
K31, K42, K51, K61, K62, K71, K72, K01, K02, K11, K12, K21, \
K30, K40, K50, K60, K70, K00, K10, K20 \
) { \
{ K00, K01, K02, K03, K04, K05, K06, K07 }, \
{ K10, K11, K12, K13, K14, K15, K16, K17 }, \
{ K20, K21, KC_NO, K23, K24, K25, KC_NO, K27 }, \
{ K30, K31, K32, K33, K34, K35, K36, K37 }, \
{ K40, KC_NO, K42, K43, K44, K45, K46, K47 }, \
{ K50, K51, K52, K53, K54, K55, K56, K57 }, \
{ K60, K61, K62, K63, K64, K65, K66, K67 }, \
{ K70, K71, K72, K73, K74, K75, K76, K77 } \
}
```
This layout needs to match the layout defined in
qmk_firmware/layouts/community/layout.json
### 2. Configuring rules.mk
`rules.mk` needs to have the following line:
LAYOUTS = 60_ansi
### 3. Defining a keymap
A keymap must be defined at
qmk_firmware/layouts/community/60_ansi/yourfoldername/keymap.c
This keymap must have a `LAYOUT_60_ansi` layout defined.
```c
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[BASE] = LAYOUT_60_ansi(
QK_GESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS,
KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
KC_LCTL, KC_LALT, KC_LGUI, KC_SPACE, MO(1), KC_RALT, KC_RGUI, KC_RCTL),
};
```
## Usage
To make generate a hex file, type
make yourkeyboard:yourfoldername
This hex file will contain a keymap with layout `LAYOUT_60_ansi` derived from
qmk_firmware/layouts/community/60_ansi/yourfoldername/keymap.c
LAYOUT_60_ansi

3
layouts/community/60_ansi_arrow/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_ansi_arrow
LAYOUT_60_ansi_arrow

3
layouts/community/60_ansi_arrow_split_bs_7u_spc/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_ansi_arrow_split_bs_7u_spc
LAYOUT_60_ansi_arrow_split_bs_7u_spc

2
layouts/community/60_ansi_split_bs_rshift/readme.md
View File

@ -1,3 +1,3 @@
# 60_ansi_split_bs_rshift
LAYOUT_60_ansi_split_bs_rshift
LAYOUT_60_ansi_split_bs_rshift

3
layouts/community/60_ansi_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_ansi_tsangan
LAYOUT_60_ansi_tsangan

3
layouts/community/60_ansi_wkl/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_ansi_wkl
LAYOUT_60_ansi_wkl

3
layouts/community/60_ansi_wkl_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_ansi_wkl_split_bs_rshift
LAYOUT_60_ansi_wkl_split_bs_rshift

3
layouts/community/60_hhkb/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_hhkb
LAYOUT_60_hhkb

2
layouts/community/60_iso/readme.md
View File

@ -1,3 +1,3 @@
# 60_iso
LAYOUT_60_iso
LAYOUT_60_iso

3
layouts/community/60_iso_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_iso_split_bs_rshift
LAYOUT_60_iso_split_bs_rshift

3
layouts/community/60_iso_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_iso_tsangan
LAYOUT_60_iso_tsangan

3
layouts/community/60_iso_tsangan_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_iso_tsangan_split_bs_rshift
LAYOUT_60_iso_tsangan_split_bs_rshift

3
layouts/community/60_iso_wkl/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_iso_wkl
LAYOUT_60_iso_wkl

3
layouts/community/60_iso_wkl_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_iso_wkl_split_bs_rshift
LAYOUT_60_iso_wkl_split_bs_rshift

3
layouts/community/60_jis/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_jis
LAYOUT_60_jis

3
layouts/community/60_tsangan_hhkb/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 60_tsangan_hhkb
LAYOUT_60_tsangan_hhkb

3
layouts/community/64_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 64_ansi
LAYOUT_64_ansi

3
layouts/community/64_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 64_iso
LAYOUT_64_iso

3
layouts/community/65_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi
LAYOUT_65_ansi

3
layouts/community/65_ansi_blocker/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi_blocker
LAYOUT_65_ansi_blocker

3
layouts/community/65_ansi_blocker_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi_blocker_split_bs
LAYOUT_65_ansi_blocker_split_bs

3
layouts/community/65_ansi_blocker_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi_blocker_tsangan
LAYOUT_65_ansi_blocker_tsangan

3
layouts/community/65_ansi_blocker_tsangan_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi_blocker_tsangan_split_bs
LAYOUT_65_ansi_blocker_tsangan_split_bs

3
layouts/community/65_ansi_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_ansi_split_bs
LAYOUT_65_ansi_split_bs

3
layouts/community/65_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso
LAYOUT_65_iso

3
layouts/community/65_iso_blocker/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso_blocker
LAYOUT_65_iso_blocker

3
layouts/community/65_iso_blocker_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso_blocker_split_bs
LAYOUT_65_iso_blocker_split_bs

3
layouts/community/65_iso_blocker_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso_blocker_tsangan
LAYOUT_65_iso_blocker_tsangan

3
layouts/community/65_iso_blocker_tsangan_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso_blocker_tsangan_split_bs
LAYOUT_65_iso_blocker_tsangan_split_bs

3
layouts/community/65_iso_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 65_iso_split_bs
LAYOUT_65_iso_split_bs

3
layouts/community/66_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 66_iso
LAYOUT_66_iso

2
layouts/community/68_ansi/readme.md
View File

@ -1,5 +1,3 @@
# 68_ansi
LAYOUT_68_ansi
This is the 68 key ANSI layout made popular by boards such as the Magicforce 68 and Varmilo VA68M.

3
layouts/community/68_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 68_iso
LAYOUT_68_iso

70
layouts/community/75_ansi/readme.md
View File

@ -1,71 +1,3 @@
# 75_ansi
This is the standard 75% ANSI keyboard layout.
One may argue that having 3 1u keys to the right of spacebar
is not desired as two 1.5u keys. However, most 75% boards that
come out have that as the standard.
## Requirements
### 1. Layout defined
A keyboard's `.h` file needs to have `LAYOUT_75_ansi` defined
```c
#define LAYOUT_75_ansi( \
K5A, K5B, K5C, K5D, K5E, K5F, K5G, K5H, K5I, K5J, K5K, K5L, K5M, K5N, K5O, K5Q, \
K4A, K4B, K4C, K4D, K4E, K4F, K4G, K4H, K4I, K4J, K4K, K4L, K4M, K4O, K4P, \
K3A, K3B, K3C, K3D, K3E, K3F, K3G, K3H, K3I, K3J, K3K, K3L, K3M, K3O, K3P, \
K2A, K2B, K2C, K2D, K2E, K2F, K2G, K2H, K2I, K2J, K2K, K2L, K2O, K2P, \
K1A, K1C, K1D, K1E, K1F, K1G, K1H, K1I, K1J, K1K, K1M, K1N, K1O, K1P, \
K0A, K0B, K0C, K0J, K0K, K0L, K0M, K0N, K0O, K0P \
) { \
{ K5A, K5B, K5C, K5D, K5E, K5F, K5G, K5H, K5I, K5J, K5K, K5L, K5M, K5N, K5O, KC_NO, K5Q }, \
{ K4A, K4B, K4C, K4D, K4E, K4F, K4G, K4H, K4I, K4J, K4K, K4L, K4M, KC_NO, K4O, K4P, KC_NO }, \
{ K3A, K3B, K3C, K3D, K3E, K3F, K3G, K3H, K3I, K3J, K3K, K3L, K3M, KC_NO, K3O, K3P, KC_NO }, \
{ K2A, K2B, K2C, K2D, K2E, K2F, K2G, K2H, K2I, K2J, K2K, K2L, KC_NO, KC_NO, K2O, K2P, KC_NO }, \
{ K1A, KC_NO, K1C, K1D, K1E, K1F, K1G, K1H, K1I, K1J, K1K, KC_NO, K1M, K1N, K1O, K1P, KC_NO }, \
{ K0A, K0B, K0C, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K0J, KC_NO, K0K, K0L, K0M, K0N, K0O, K0P, KC_NO } \
}
```
This layout needs to match the layout defined in
qmk_firmware/layouts/community/75_ansi/layout.json
### 2. Configuring rules.mk
`rules.mk` needs to have the following line:
LAYOUTS = 75_ansi
### 3. Defining a keymap
A keymap must be defined at
qmk_firmware/layouts/community/75_ansi/yourfoldername/keymap.c
This keymap must have a `LAYOUT_75_ansi` layout defined.
```c
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT_75_ansi(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_PAUS, KC_DEL,
KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_HOME,
KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_PGUP,
KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_PGDN,
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_END,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT)
};
```
## Usage
To make generate a hex file, type
make yourkeyboard:yourfoldername
This hex file will contain a keymap with layout `LAYOUT_75_ansi` derived from
qmk_firmware/layouts/community/75_ansi/yourfoldername/keymap.c
LAYOUT_75_ansi

3
layouts/community/75_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 75_iso
LAYOUT_75_iso

3
layouts/community/96_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 96_ansi
LAYOUT_96_ansi

3
layouts/community/96_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# 96_iso
LAYOUT_96_iso

3
layouts/community/alice/readme.md Normal file
View File

@ -0,0 +1,3 @@
# alice
LAYOUT_alice

3
layouts/community/alice_split_bs/readme.md Normal file
View File

@ -0,0 +1,3 @@
# alice_split_bs
LAYOUT_alice_split_bs

2
layouts/community/ergodox/readme.md
View File

@ -1,3 +1,3 @@
# ergodox
LAYOUT_ergodox
LAYOUT_ergodox

3
layouts/community/fullsize_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_ansi
LAYOUT_fullsize_ansi

3
layouts/community/fullsize_extended_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_extended_ansi
LAYOUT_fullsize_extended_ansi

3
layouts/community/fullsize_extended_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_extended_iso
LAYOUT_fullsize_extended_iso

3
layouts/community/fullsize_extended_jis/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_extended_jis
LAYOUT_fullsize_extended_jis

3
layouts/community/fullsize_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_iso
LAYOUT_fullsize_iso

3
layouts/community/fullsize_jis/readme.md Normal file
View File

@ -0,0 +1,3 @@
# fullsize_jis
LAYOUT_fullsize_jis

3
layouts/community/numpad_4x4/readme.md Normal file
View File

@ -0,0 +1,3 @@
# numpad_4x4
LAYOUT_numpad_4x4

3
layouts/community/numpad_5x4/readme.md Normal file
View File

@ -0,0 +1,3 @@
# numpad_5x4
LAYOUT_numpad_5x4

3
layouts/community/numpad_6x4/readme.md Normal file
View File

@ -0,0 +1,3 @@
# numpad_6x4
LAYOUT_numpad_6x4

3
layouts/community/numpad_6x5/readme.md Normal file
View File

@ -0,0 +1,3 @@
# numpad_6x5
LAYOUT_numpad_6x5

3
layouts/community/ortho_1x1/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_1x1
LAYOUT_ortho_1x1

3
layouts/community/ortho_3x3/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_3x3
LAYOUT_ortho_3x3

3
layouts/community/ortho_4x10/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_4x10
LAYOUT_ortho_4x10

2
layouts/community/ortho_4x12/readme.md
View File

@ -1,3 +1,3 @@
# ortho_4x12
LAYOUT_ortho_4x12
LAYOUT_ortho_4x12

3
layouts/community/ortho_4x16/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_4x16
LAYOUT_ortho_4x16

2
layouts/community/ortho_4x4/readme.md
View File

@ -1,3 +1,3 @@
# ortho_4x4
LAYOUT_ortho_4x4
LAYOUT_ortho_4x4

3
layouts/community/ortho_4x6/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_4x6
LAYOUT_ortho_4x6

2
layouts/community/ortho_5x12/readme.md
View File

@ -1,3 +1,3 @@
# ortho_5x12
LAYOUT_ortho_5x12
LAYOUT_ortho_5x12

3
layouts/community/ortho_5x14/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_5x14
LAYOUT_ortho_5x14

2
layouts/community/ortho_5x15/readme.md
View File

@ -1,3 +1,3 @@
# ortho_5x15
LAYOUT_ortho_5x15
LAYOUT_ortho_5x15

3
layouts/community/ortho_5x4/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_5x4
LAYOUT_ortho_5x4

2
layouts/community/ortho_5x5/readme.md
View File

@ -1,3 +1,3 @@
# ortho_5x5
LAYOUT_ortho_5x5
LAYOUT_ortho_5x5

3
layouts/community/ortho_6x4/readme.md Normal file
View File

@ -0,0 +1,3 @@
# ortho_6x4
LAYOUT_ortho_6x4

3
layouts/community/planck_mit/readme.md Normal file
View File

@ -0,0 +1,3 @@
# planck_mit
LAYOUT_planck_mit

3
layouts/community/split_3x5_2/readme.md Normal file
View File

@ -0,0 +1,3 @@
# split_3x5_2
LAYOUT_split_3x5_2

3
layouts/community/split_3x5_3/readme.md Normal file
View File

@ -0,0 +1,3 @@
# split_3x5_3
LAYOUT_split_3x5_3

3
layouts/community/split_3x6_3/readme.md Normal file
View File

@ -0,0 +1,3 @@
# split_3x6_3
LAYOUT_split_3x6_3

3
layouts/community/tkl_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_ansi
LAYOUT_tkl_ansi

3
layouts/community/tkl_ansi_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_ansi_split_bs_rshift
LAYOUT_tkl_ansi_split_bs_rshift

3
layouts/community/tkl_ansi_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_ansi_tsangan
LAYOUT_tkl_ansi_tsangan

3
layouts/community/tkl_ansi_tsangan_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_ansi_tsangan_split_bs_rshift
LAYOUT_tkl_ansi_tsangan_split_bs_rshift

3
layouts/community/tkl_f13_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_ansi
LAYOUT_tkl_f13_ansi

3
layouts/community/tkl_f13_ansi_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_ansi_split_bs_rshift
LAYOUT_tkl_f13_ansi_split_bs_rshift

3
layouts/community/tkl_f13_ansi_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_ansi_tsangan
LAYOUT_tkl_f13_ansi_tsangan

3
layouts/community/tkl_f13_ansi_tsangan_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_ansi_tsangan_split_bs_rshift
LAYOUT_tkl_f13_ansi_tsangan_split_bs_rshift

3
layouts/community/tkl_f13_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_iso
LAYOUT_tkl_f13_iso

3
layouts/community/tkl_f13_iso_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_iso_split_bs_rshift
LAYOUT_tkl_f13_iso_split_bs_rshift

3
layouts/community/tkl_f13_iso_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_iso_tsangan
LAYOUT_tkl_f13_iso_tsangan

3
layouts/community/tkl_f13_iso_tsangan_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_iso_tsangan_split_bs_rshift
LAYOUT_tkl_f13_iso_tsangan_split_bs_rshift

3
layouts/community/tkl_f13_jis/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_f13_jis
LAYOUT_tkl_f13_jis

3
layouts/community/tkl_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_iso
LAYOUT_tkl_iso

3
layouts/community/tkl_iso_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_iso_split_bs_rshift
LAYOUT_tkl_iso_split_bs_rshift

3
layouts/community/tkl_iso_tsangan/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_iso_tsangan
LAYOUT_tkl_iso_tsangan

3
layouts/community/tkl_iso_tsangan_split_bs_rshift/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_iso_tsangan_split_bs_rshift
LAYOUT_tkl_iso_tsangan_split_bs_rshift

3
layouts/community/tkl_jis/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_jis
LAYOUT_tkl_jis

3
layouts/community/tkl_nofrow_ansi/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_nofrow_ansi
LAYOUT_tkl_nofrow_ansi

3
layouts/community/tkl_nofrow_iso/readme.md Normal file
View File

@ -0,0 +1,3 @@
# tkl_nofrow_iso
LAYOUT_tkl_nofrow_iso