summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-03-29 22:37:20 -0400
committerJack Humbert <jack.humb@gmail.com>2016-03-29 22:37:20 -0400
commit4a676746a6d8c9b47956f863ead335e995677c53 (patch)
treeabec71f825ce412d13e057bc1bd89018cf3bb8f7
parent26513b497b8bae5160389c0beac2d45cbb29c50f (diff)
parent95fba250ef2029ccdedb34500c5d1e96f6d065cf (diff)
Merge pull request #224 from NoahAndrews/make-keymap-names-consistent
Make keymap names more consistent
-rw-r--r--BUILD_GUIDE.md5
-rw-r--r--keyboard/alps64/Makefile4
-rw-r--r--keyboard/alps64/keymaps/default.c (renamed from keyboard/alps64/keymap_plain.c)0
-rw-r--r--keyboard/alps64/keymaps/hasu.c (renamed from keyboard/alps64/keymap_hasu.c)0
-rw-r--r--keyboard/atomic/Makefile4
-rw-r--r--keyboard/atomic/README.md4
-rw-r--r--keyboard/atomic/keymaps/abienz.c (renamed from keyboard/atomic/keymaps/keymap_abienz.c)0
-rw-r--r--keyboard/atomic/keymaps/default.c (renamed from keyboard/atomic/keymaps/keymap_default.c)0
-rw-r--r--keyboard/atomic/keymaps/michelle.c (renamed from keyboard/atomic/keymaps/keymap_michelle.c)0
-rw-r--r--keyboard/atreus/Makefile4
-rw-r--r--keyboard/atreus/README.md4
-rw-r--r--keyboard/atreus/keymaps/default.c (renamed from keyboard/atreus/keymaps/keymap_default.c)0
-rw-r--r--keyboard/atreus/keymaps/gerb.c (renamed from keyboard/atreus/keymaps/keymap_gerb.c)0
-rw-r--r--keyboard/gh60/Makefile4
-rw-r--r--keyboard/gh60/Makefile.pjrc4
-rw-r--r--keyboard/gh60/README.md14
-rw-r--r--keyboard/gh60/keymaps/hasu.c (renamed from keyboard/gh60/keymap_hasu.c)0
-rw-r--r--keyboard/gh60/keymaps/hhkb.c (renamed from keyboard/gh60/keymap_hhkb.c)0
-rw-r--r--keyboard/gh60/keymaps/plain.c (renamed from keyboard/gh60/keymap_plain.c)0
-rw-r--r--keyboard/gh60/keymaps/poker.c (renamed from keyboard/gh60/keymap_poker.c)0
-rw-r--r--keyboard/gh60/keymaps/poker_bit.c (renamed from keyboard/gh60/keymap_poker_bit.c)0
-rw-r--r--keyboard/gh60/keymaps/poker_set.c (renamed from keyboard/gh60/keymap_poker_set.c)0
-rw-r--r--keyboard/gh60/keymaps/spacefn.c (renamed from keyboard/gh60/keymap_spacefn.c)0
-rw-r--r--keyboard/hhkb/Makefile8
-rw-r--r--keyboard/hhkb/Makefile.pjrc4
-rw-r--r--keyboard/hhkb/Makefile.rn428
-rw-r--r--keyboard/hhkb/README.md2
-rw-r--r--keyboard/hhkb/keymaps/hasu.c (renamed from keyboard/hhkb/keymap_hasu.c)0
-rw-r--r--keyboard/hhkb/keymaps/hhkb.c (renamed from keyboard/hhkb/keymap_hhkb.c)0
-rw-r--r--keyboard/hhkb/keymaps/jp.c (renamed from keyboard/hhkb/keymap_jp.c)0
-rw-r--r--keyboard/hhkb/keymaps/spacefn.c (renamed from keyboard/hhkb/keymap_spacefn.c)0
-rw-r--r--keyboard/hhkb_qmk/Makefile4
-rw-r--r--keyboard/hhkb_qmk/README.md4
-rw-r--r--keyboard/hhkb_qmk/keymaps/default.c (renamed from keyboard/hhkb_qmk/keymaps/keymap_default.c)0
-rw-r--r--keyboard/hhkb_qmk/keymaps/lxol.c (renamed from keyboard/hhkb_qmk/keymaps/keymap_lxol.c)0
-rw-r--r--keyboard/jd45/Makefile4
-rw-r--r--keyboard/jd45/keymaps/default.c (renamed from keyboard/jd45/keymaps/keymap_default.c)0
-rw-r--r--keyboard/jd45/keymaps/justin.c (renamed from keyboard/jd45/keymaps/keymap_justin.c)0
-rw-r--r--keyboard/planck/README.md4
-rw-r--r--keyboard/planck/old_keymap_files/common_keymaps/keymap_mitch.c (renamed from keyboard/planck/common_keymaps/keymap_mitch.c)0
-rw-r--r--quantum/template/README.md2
41 files changed, 45 insertions, 42 deletions
diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md
index 22df53c30d..f7a57d2fc9 100644
--- a/BUILD_GUIDE.md
+++ b/BUILD_GUIDE.md
@@ -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)
diff --git a/keyboard/alps64/Makefile b/keyboard/alps64/Makefile
index e90dcedb67..7634c4280e 100644
--- a/keyboard/alps64/Makefile
+++ b/keyboard/alps64/Makefile
@@ -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
diff --git a/keyboard/alps64/keymap_plain.c b/keyboard/alps64/keymaps/default.c
index a54899196a..a54899196a 100644
--- a/keyboard/alps64/keymap_plain.c
+++ b/keyboard/alps64/keymaps/default.c
diff --git a/keyboard/alps64/keymap_hasu.c b/keyboard/alps64/keymaps/hasu.c
index d297d72fea..d297d72fea 100644
--- a/keyboard/alps64/keymap_hasu.c
+++ b/keyboard/alps64/keymaps/hasu.c
diff --git a/keyboard/atomic/Makefile b/keyboard/atomic/Makefile
index e678b4efa8..da6d0ac60c 100644
--- a/keyboard/atomic/Makefile
+++ b/keyboard/atomic/Makefile
@@ -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
diff --git a/keyboard/atomic/README.md b/keyboard/atomic/README.md
index c8e83cf55a..0e42370ba6 100644
--- a/keyboard/atomic/README.md
+++ b/keyboard/atomic/README.md
@@ -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.
diff --git a/keyboard/atomic/keymaps/keymap_abienz.c b/keyboard/atomic/keymaps/abienz.c
index 589a64dc4e..589a64dc4e 100644
--- a/keyboard/atomic/keymaps/keymap_abienz.c
+++ b/keyboard/atomic/keymaps/abienz.c
diff --git a/keyboard/atomic/keymaps/keymap_default.c b/keyboard/atomic/keymaps/default.c
index f37d9d9a51..f37d9d9a51 100644
--- a/keyboard/atomic/keymaps/keymap_default.c
+++ b/keyboard/atomic/keymaps/default.c
diff --git a/keyboard/atomic/keymaps/keymap_michelle.c b/keyboard/atomic/keymaps/michelle.c
index 2364c46a15..2364c46a15 100644
--- a/keyboard/atomic/keymaps/keymap_michelle.c
+++ b/keyboard/atomic/keymaps/michelle.c
diff --git a/keyboard/atreus/Makefile b/keyboard/atreus/Makefile
index 2e542d62ed..a6fddd70d2 100644
--- a/keyboard/atreus/Makefile
+++ b/keyboard/atreus/Makefile
@@ -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
diff --git a/keyboard/atreus/README.md b/keyboard/atreus/README.md
index 4db7ac1203..aacf2841f4 100644
--- a/keyboard/atreus/README.md
+++ b/keyboard/atreus/README.md
@@ -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.
diff --git a/keyboard/atreus/keymaps/keymap_default.c b/keyboard/atreus/keymaps/default.c
index 1c4280ff56..1c4280ff56 100644
--- a/keyboard/atreus/keymaps/keymap_default.c
+++ b/keyboard/atreus/keymaps/default.c
diff --git a/keyboard/atreus/keymaps/keymap_gerb.c b/keyboard/atreus/keymaps/gerb.c
index 1ba3942e3b..1ba3942e3b 100644
--- a/keyboard/atreus/keymaps/keymap_gerb.c
+++ b/keyboard/atreus/keymaps/gerb.c
diff --git a/keyboard/gh60/Makefile b/keyboard/gh60/Makefile
index daba0f6449..4c8f9dc8ab 100644
--- a/keyboard/gh60/Makefile
+++ b/keyboard/gh60/Makefile
@@ -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
diff --git a/keyboard/gh60/Makefile.pjrc b/keyboard/gh60/Makefile.pjrc
index 11bd3b7840..8ed73a248d 100644
--- a/keyboard/gh60/Makefile.pjrc
+++ b/keyboard/gh60/Makefile.pjrc
@@ -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
diff --git a/keyboard/gh60/README.md b/keyboard/gh60/README.md
index 510cb5c8b6..41a757ea3a 100644
--- a/keyboard/gh60/README.md
+++ b/keyboard/gh60/README.md
@@ -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| -| =| \| `|
diff --git a/keyboard/gh60/keymap_hasu.c b/keyboard/gh60/keymaps/hasu.c
index e6af28585b..e6af28585b 100644
--- a/keyboard/gh60/keymap_hasu.c
+++ b/keyboard/gh60/keymaps/hasu.c
diff --git a/keyboard/gh60/keymap_hhkb.c b/keyboard/gh60/keymaps/hhkb.c
index ce1b816ecb..ce1b816ecb 100644
--- a/keyboard/gh60/keymap_hhkb.c
+++ b/keyboard/gh60/keymaps/hhkb.c
diff --git a/keyboard/gh60/keymap_plain.c b/keyboard/gh60/keymaps/plain.c
index 3138c18077..3138c18077 100644
--- a/keyboard/gh60/keymap_plain.c
+++ b/keyboard/gh60/keymaps/plain.c
diff --git a/keyboard/gh60/keymap_poker.c b/keyboard/gh60/keymaps/poker.c
index 7a612ee44d..7a612ee44d 100644
--- a/keyboard/gh60/keymap_poker.c
+++ b/keyboard/gh60/keymaps/poker.c
diff --git a/keyboard/gh60/keymap_poker_bit.c b/keyboard/gh60/keymaps/poker_bit.c
index b8870fdd81..b8870fdd81 100644
--- a/keyboard/gh60/keymap_poker_bit.c
+++ b/keyboard/gh60/keymaps/poker_bit.c
diff --git a/keyboard/gh60/keymap_poker_set.c b/keyboard/gh60/keymaps/poker_set.c
index aaa31fc571..aaa31fc571 100644
--- a/keyboard/gh60/keymap_poker_set.c
+++ b/keyboard/gh60/keymaps/poker_set.c
diff --git a/keyboard/gh60/keymap_spacefn.c b/keyboard/gh60/keymaps/spacefn.c
index 8077dcee7b..8077dcee7b 100644
--- a/keyboard/gh60/keymap_spacefn.c
+++ b/keyboard/gh60/keymaps/spacefn.c
diff --git a/keyboard/hhkb/Makefile b/keyboard/hhkb/Makefile
index 5a179bd24d..d434246cef 100644
--- a/keyboard/hhkb/Makefile
+++ b/keyboard/hhkb/Makefile
@@ -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
diff --git a/keyboard/hhkb/Makefile.pjrc b/keyboard/hhkb/Makefile.pjrc
index 7d0f8c3a9c..403a8ec60a 100644
--- a/keyboard/hhkb/Makefile.pjrc
+++ b/keyboard/hhkb/Makefile.pjrc
@@ -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
diff --git a/keyboard/hhkb/Makefile.rn42 b/keyboard/hhkb/Makefile.rn42
index cbb2b744c9..a730442af0 100644
--- a/keyboard/hhkb/Makefile.rn42
+++ b/keyboard/hhkb/Makefile.rn42
@@ -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
diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index fcd72e1941..e20c23d823 100644
--- a/keyboard/hhkb/README.md
+++ b/keyboard/hhkb/README.md
@@ -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
diff --git a/keyboard/hhkb/keymap_hasu.c b/keyboard/hhkb/keymaps/hasu.c
index a5602ded31..a5602ded31 100644
--- a/keyboard/hhkb/keymap_hasu.c
+++ b/keyboard/hhkb/keymaps/hasu.c
diff --git a/keyboard/hhkb/keymap_hhkb.c b/keyboard/hhkb/keymaps/hhkb.c
index 86ad0f5eee..86ad0f5eee 100644
--- a/keyboard/hhkb/keymap_hhkb.c
+++ b/keyboard/hhkb/keymaps/hhkb.c
diff --git a/keyboard/hhkb/keymap_jp.c b/keyboard/hhkb/keymaps/jp.c
index 48d0ee70ba..48d0ee70ba 100644
--- a/keyboard/hhkb/keymap_jp.c
+++ b/keyboard/hhkb/keymaps/jp.c
diff --git a/keyboard/hhkb/keymap_spacefn.c b/keyboard/hhkb/keymaps/spacefn.c
index deff920ae2..deff920ae2 100644
--- a/keyboard/hhkb/keymap_spacefn.c
+++ b/keyboard/hhkb/keymaps/spacefn.c
diff --git a/keyboard/hhkb_qmk/Makefile b/keyboard/hhkb_qmk/Makefile
index 8bd44100b7..21ba261a23 100644
--- a/keyboard/hhkb_qmk/Makefile
+++ b/keyboard/hhkb_qmk/Makefile
@@ -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
diff --git a/keyboard/hhkb_qmk/README.md b/keyboard/hhkb_qmk/README.md
index 606025c411..389407b3aa 100644
--- a/keyboard/hhkb_qmk/README.md
+++ b/keyboard/hhkb_qmk/README.md
@@ -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.
diff --git a/keyboard/hhkb_qmk/keymaps/keymap_default.c b/keyboard/hhkb_qmk/keymaps/default.c
index bcd8ead377..bcd8ead377 100644
--- a/keyboard/hhkb_qmk/keymaps/keymap_default.c
+++ b/keyboard/hhkb_qmk/keymaps/default.c
diff --git a/keyboard/hhkb_qmk/keymaps/keymap_lxol.c b/keyboard/hhkb_qmk/keymaps/lxol.c
index 3256fda516..3256fda516 100644
--- a/keyboard/hhkb_qmk/keymaps/keymap_lxol.c
+++ b/keyboard/hhkb_qmk/keymaps/lxol.c
diff --git a/keyboard/jd45/Makefile b/keyboard/jd45/Makefile
index 076dced829..f6a8d10c58 100644
--- a/keyboard/jd45/Makefile
+++ b/keyboard/jd45/Makefile
@@ -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
diff --git a/keyboard/jd45/keymaps/keymap_default.c b/keyboard/jd45/keymaps/default.c
index 05dd46e792..05dd46e792 100644
--- a/keyboard/jd45/keymaps/keymap_default.c
+++ b/keyboard/jd45/keymaps/default.c
diff --git a/keyboard/jd45/keymaps/keymap_justin.c b/keyboard/jd45/keymaps/justin.c
index f261b54633..f261b54633 100644
--- a/keyboard/jd45/keymaps/keymap_justin.c
+++ b/keyboard/jd45/keymaps/justin.c
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index 3ba0cc1527..d9a1e3beee 100644
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -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)
diff --git a/keyboard/planck/common_keymaps/keymap_mitch.c b/keyboard/planck/old_keymap_files/common_keymaps/keymap_mitch.c
index f7df7bbbaa..f7df7bbbaa 100644
--- a/keyboard/planck/common_keymaps/keymap_mitch.c
+++ b/keyboard/planck/old_keymap_files/common_keymaps/keymap_mitch.c
diff --git a/quantum/template/README.md b/quantum/template/README.md
index dc163a2f4b..39f9f59d10 100644
--- a/quantum/template/README.md
+++ b/quantum/template/README.md
@@ -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:
```