aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9c8372b97..be7cd0a85 100644
--- a/README.md
+++ b/README.md
@@ -38,13 +38,13 @@ You have access to a bunch of goodies! Check out the Makefile to enable/disable
38 38
39### Customizing Makefile options on a per-keymap basis 39### Customizing Makefile options on a per-keymap basis
40 40
41If your keymap directory has a file called `makefile.mk` (note the lowercase filename, and the `.mk` extension), any Makefile options you set in that file will take precedence over other Makefile options (those set for Quantum as a whole or for your particular keyboard). 41If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options (those set for Quantum as a whole or for your particular keyboard).
42 42
43So let's say your keyboard's makefile has `CONSOLE_ENABLE = yes` (or maybe doesn't even list the `CONSOLE_ENABLE` option, which would cause it to revert to the global Quantum default). You want your particular keymap to not have the debug console, so you make a file called `makefile.mk` and specify `CONSOLE_ENABLE = no`. 43So let's say your keyboard's makefile has `CONSOLE_ENABLE = yes` (or maybe doesn't even list the `CONSOLE_ENABLE` option, which would cause it to revert to the global Quantum default). You want your particular keymap to not have the debug console, so you make a file called `Makefile` and specify `CONSOLE_ENABLE = no`.
44 44
45### Customizing config.h on a per-keymap basis 45### Customizing config.h on a per-keymap basis
46 46
47If you use the ErgoDox EZ, you can make a `config_user.h` file in your keymap directory and use it to override any `config.h` settings you don't like. Anything you set there will take precedence over the global `config.h` for the ErgoDox EZ. To see an example of this, check out `keymaps/erez_experimental`. 47You can also make a `config.h` file in your keymap directory and use it to override any `config.h` settings you don't like. Anything you set there will take precedence over the global `config.h` for the ErgoDox EZ. To see an example of this, check out `keymaps/erez_experimental`.
48 48
49## Quick aliases to common actions 49## Quick aliases to common actions
50 50
@@ -134,12 +134,12 @@ Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/)
134 134
135To use it, use `KC_LSPO` (Left Shift, Parens Open) for your left Shift on your keymap, and `KC_RSPC` (Right Shift, Parens Close) for your right Shift. 135To use it, use `KC_LSPO` (Left Shift, Parens Open) for your left Shift on your keymap, and `KC_RSPC` (Right Shift, Parens Close) for your right Shift.
136 136
137It's defaulted to work on US keyboards, but if your layout uses different keys for parenthesis, you can define those in your keymap like this: 137It's defaulted to work on US keyboards, but if your layout uses different keys for parenthesis, you can define those in your `config.h` like this:
138 138
139 #define LSPO_KEY KC_9 139 #define LSPO_KEY KC_9
140 #define RSPC_KEY KC_0 140 #define RSPC_KEY KC_0
141 141
142The only other thing you're going to want to do is create a `makefile.mk` in your keymap directory and set the following: 142The only other thing you're going to want to do is create a `Makefile` in your keymap directory and set the following:
143 143
144``` 144```
145COMMAND_ENABLE = no # Commands for debug and configuration 145COMMAND_ENABLE = no # Commands for debug and configuration