layouts/community/60_ansi/readme.md

   1 # 60_ansi
   2
   3 This is the standard 60% ANSI keyboard layout.
   4
   5 ## Requirements
   6
   7 ### 1. Layout defined
   8
   9 A keyboard's `.h` file needs to have `LAYOUT_60_ansi` defined
  10
  11 ```c
  12 #define LAYOUT_60_ansi( \
  13     K36, K37, K46, K47, K56, K57, K66, K67, K76, K77, K06, K07, K17,      K27, \
  14     K34, K35, K44, K45, K54, K55, K64, K65, K75, K05, K15, K16, K25, K24, \
  15     K32, K33, K43, K52, K53, K63, K73, K74, K03, K04, K13, K14, K23, \
  16     K31,      K42, K51, K61, K62, K71, K72, K01, K02, K11, K12, K21,  \
  17     K30, K40, K50,           K60,                     K70, K00, K10, K20  \
  18 ) { \
  19     { K00, K01,   K02,   K03, K04, K05, K06,   K07 }, \
  20     { K10, K11,   K12,   K13, K14, K15, K16,   K17 }, \
  21     { K20, K21,   KC_NO, K23, K24, K25, KC_NO, K27 }, \
  22     { K30, K31,   K32,   K33, K34, K35, K36,   K37 }, \
  23     { K40, KC_NO, K42,   K43, K44, K45, K46,   K47 }, \
  24     { K50, K51,   K52,   K53, K54, K55, K56,   K57 }, \
  25     { K60, K61,   K62,   K63, K64, K65, K66,   K67 }, \
  26     { K70, K71,   K72,   K73, K74, K75, K76,   K77 } \
  27 }
  28 )
  29 ```
  30
  31 This layout needs to match the layout defined in
  32
  33         qmk_firmware/layouts/community/layout.json
  34
  35 ### 2. Configuring rules.mk
  36
  37 `rules.mk` needs to have the following line:
  38
  39         LAYOUTS = 60_ansi
  40
  41 ### 3. Defining a keymap
  42
  43 A keymap must be defined at
  44
  45     qmk_firmware/layouts/community/60_ansi/yourfoldername/keymap.c
  46
  47 This keymap must have a `LAYOUT_60_ansi` layout defined.
  48
  49 ```c
  50 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  51 [BASE] = LAYOUT_60_ansi(
  52     KC_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, \
  53         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_BSLASH, \
  54     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,  \
  55     KC_LSFT, KC_Z,    KC_X, KC_C, KC_V, KC_B, KC_N, KC_M,  KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, \
  56     KC_LCTL, KC_LALT, KC_LGUI,       KC_SPACE,             MO(1),   KC_RALT, KC_RGUI, KC_RCTL),
  57  };
  58 ```
  59
  60 ## Usage
  61
  62 To make generate a hex file, type
  63
  64     make yourkeyboard:yourfoldername
  65
  66 This hex file will contain a keymap with layout `LAYOUT_60_ansi` derived from
  67
  68     qmk_firmware/layouts/community/60_ansi/yourfoldername/keymap.c