1
0
Fork 0

Merge pull request #224 from NoahAndrews/make-keymap-names-consistent

Make keymap names more consistent
This commit is contained in:
Jack Humbert 2016-03-29 22:37:20 -04:00
commit 4a676746a6
41 changed files with 45 additions and 42 deletions

View file

@ -44,7 +44,10 @@ If you have any problems building the firmware, you can try using a tool called
4. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process.
## Customizing, Building, and Deploying Your Firmware
1. Running the `make` command from your keyboard's folder will generate a .hex file based on the default keymap. All keymaps for a particular keyboard live in the `keymaps` folder in that keyboard's folder. To create your own keymap, copy `keymaps/default/keymap.c` to the `keymaps` folder, and rename it with your name, for example jack.c. Or, if you don't care about the ability to share your keymap with the community via GitHub, you can just modify the default keymap itself. Details on how to program keymap files can be found in other guides.
Note: Some keyboard folders have non-standard organizations, and may not even support specifying alternate keymaps. Until these get reorganized, you will need to edit their default keymaps directly.
1. Running the `make` command from your keyboard's folder will generate a .hex file based on the default keymap. All keymaps for a particular keyboard live in the `keymaps` folder in that keyboard's folder. To create your own keymap, copy `keymaps/default/keymap.c` to the `keymaps` folder, and rename it with your name, for example jack.c. Or, if you don't care about the ability to share your keymap with the community via GitHub, you can just modify the default keymap itself. Details on how to program keymap files can be found in other guides.
2. To build a keymap other than the default, type `KEYMAP=<name>` after `make`. So if I've named my keymap jack.c, the full command would be `make KEYMAP=jack`.
3. How you deploy the firmware will depend on whether you are using a PCB or a Teensy. In both cases, you'll need to put the keyboard in bootloader mode, either by pressing a button on the PCB/Teensy or pressing the key with the `RESET` keycode. Then, if you're using a PCB, just run `make KEYMAP=<name> dfu` to both build and deploy the firmware. If you're using a Teensy, you'll probably need to take the <keyboardname>.hex file that make produces in the keyboard's folder, and deploy it using the [Teensy Loader.](https://www.pjrc.com/teensy/loader.html)

View file

@ -53,9 +53,9 @@ SRC = keymap_common.c \
led.c
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymap_plain.c $(SRC)
SRC := keymaps/default.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -54,9 +54,9 @@ SRC = atomic.c \
backlight.c
ifdef KEYMAP
SRC := keymaps/keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymaps/keymap_default.c $(SRC)
SRC := keymaps/default.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -16,10 +16,10 @@ Depending on which keymap you would like to use, you will have to compile slight
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 file named `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
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 file in the keymaps folder named `<name>.c` and see keymap document (you can find in top README.md) and existent 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\_\<name\>.c__** and are stored in the `keymaps` folder.
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.

View file

@ -53,9 +53,9 @@ TARGET_DIR = .
SRC = atreus.c
ifdef KEYMAP
SRC := keymaps/keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymaps/keymap_default.c $(SRC)
SRC := keymaps/default.c $(SRC)
endif
ifdef TEENSY2

View file

@ -177,10 +177,10 @@ Depending on which keymap you would like to use, you will have to compile slight
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 file named `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` and see keymap document (you can find in top README.md) and existent 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\_\<name\>.c__** and are stored in the `keymaps` folder.
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.

View file

@ -53,9 +53,9 @@ SRC = keymap_common.c \
led.c
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymap_poker.c $(SRC)
SRC := keymaps/poker.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -53,9 +53,9 @@ SRC = keymap_common.c \
led.c
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymap_poker.c $(SRC)
SRC := keymaps/poker.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -21,7 +21,7 @@ Use `make -f Makefile.pjrc` if you want to use PJRC stack but I find no reason t
## Keymap
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document(you can find in top README.md) and existent keymap files.
To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
@ -29,8 +29,8 @@ To build firmware binary hex file with a certain keymap just do `make` with `KEY
### 1 Poker
[keymap_poker.c](keymap_poker.c) emulates original Poker layers
while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
[poker.c](keymaps/poker.c) emulates original Poker layers
while both [poker_bit.c](keymaps/poker_bit.c) and [poker_set.c](keymaps/poker_set.c) implement the same layout in different ways and they fix a minor issue of original Poker and enhance arrow keys.
Fn + Esc = `
Fn + {left, down, up, right} = {home, pgdown, pgup, end}
@ -63,7 +63,7 @@ while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](key
### 2. Plain
Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
See [keymap_plain.c](keymap_plain.c) for detail.
See [plain.c](keymaps/plain.c) for detail.
#### 1.0 Plain Default layer
,-----------------------------------------------------------.
@ -80,11 +80,11 @@ See [keymap_plain.c](keymap_plain.c) for detail.
### 3. Hasu
This is my favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
This is my favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [hasu.c](keymaps/hasu.c) for detail.
### 4. SpaceFN
This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [spacefn.c](keymaps/spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
#### 4.0 Default layer
,-----------------------------------------------------------.
@ -113,7 +113,7 @@ This layout proposed by spiceBar uses space bar to change layer with using Dual
### 5. HHKB
[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.
[hhkb.c](keymaps/hhkb.c) emulates original HHKB layers.
#### 5.0: Default layer
,-----------------------------------------------------------.
|Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|

View file

@ -129,17 +129,17 @@ NKRO_ENABLE = yes # USB Nkey Rollover
# Keymap file
#
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
ifdef HHKB_JP
SRC := keymap_jp.c $(SRC)
SRC := keymaps/jp.c $(SRC)
else
SRC := keymap_hhkb.c $(SRC)
SRC := keymaps/hhkb.c $(SRC)
endif
endif
ifneq (, $(or $(findstring keymap_jp.c, $(SRC)), $(findstring yes, $(HHKB_JP))))
ifneq (, $(or $(findstring jp.c, $(SRC)), $(findstring yes, $(HHKB_JP))))
OPT_DEFS += -DHHKB_JP
endif

View file

@ -18,9 +18,9 @@ SRC = keymap_common.c \
led.c
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymap_hasu.c $(SRC)
SRC := keymaps/hasu.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -122,17 +122,17 @@ COMMAND_ENABLE = yes # Commands for debug and configuration
# Keymap file
#
ifdef KEYMAP
SRC := keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/$(KEYMAP).c $(SRC)
else
ifdef HHKB_JP
SRC := keymap_jp.c $(SRC)
SRC := keymaps/jp.c $(SRC)
else
SRC := keymap_hhkb.c $(SRC)
SRC := keymaps/hhkb.c $(SRC)
endif
endif
ifneq (, $(or $(findstring keymap_jp.c, $(SRC)), $(findstring yes, $(HHKB_JP))))
ifneq (, $(or $(findstring jp.c, $(SRC)), $(findstring yes, $(HHKB_JP))))
OPT_DEFS += -DHHKB_JP
endif

View file

@ -76,7 +76,7 @@ Use [Teensy Loader] if your controller is Teensy/Teensy++.
##Keymap
To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
To define your own keymap create a file in the keymaps folder named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
##Hardware

View file

@ -54,9 +54,9 @@ SRC = hhkb_qmk.c \
matrix.c
ifdef KEYMAP
SRC := keymaps/keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/keymaps/$(KEYMAP).c $(SRC)
else
SRC := keymaps/keymap_default.c $(SRC)
SRC := keymaps/keymaps/default.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -171,10 +171,10 @@ Depending on which keymap you would like to use, you will have to compile slight
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 file named `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
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 file in the keymaps folder named `<name>.c` and see keymap document (you can find in top README.md) and existent 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\_\<name\>.c__** and are stored in the `keymaps` folder.
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.

View file

@ -54,9 +54,9 @@ SRC = jd45.c \
backlight.c
ifdef KEYMAP
SRC := keymaps/keymap_$(KEYMAP).c $(SRC)
SRC := keymaps/keymaps/(KEYMAP).c $(SRC)
else
SRC := keymaps/keymap_default.c $(SRC)
SRC := keymaps/keymaps/default.c $(SRC)
endif
CONFIG_H = config.h

View file

@ -16,13 +16,13 @@ Depending on which keymap you would like to use, you will have to compile slight
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 file named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent 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 **__<name\>.c__** and are stored in the `keymaps` folder.
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
### Notable forks (which some of the keymap files are from)
- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)

View file

@ -15,7 +15,7 @@ Depending on which keymap you would like to use, you will have to compile slight
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 file named `<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top README.md) and existent keymap files.
To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
```