aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-06-23 23:14:21 -0400
committerJack Humbert <jack.humb@gmail.com>2016-06-23 23:14:21 -0400
commitb68b722325e1f0f68387e161365fa8e31c79b7b2 (patch)
tree5564db127c39b51922ab48a722cd1d8acb0faad0 /readme.md
parent13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b (diff)
downloadqmk_firmware-b68b722325e1f0f68387e161365fa8e31c79b7b2.tar.gz
qmk_firmware-b68b722325e1f0f68387e161365fa8e31c79b7b2.zip
updates ez's matrix to spec
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/readme.md b/readme.md
index fbd9203a5..ff75c0fe9 100644
--- a/readme.md
+++ b/readme.md
@@ -85,7 +85,7 @@ If you have any problems building the firmware, you can try using a tool called
853. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`. 853. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`.
864. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below. 864. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below.
87 87
88# Customizing, building, and flashing your keymap 88# Customizing your keymap
89 89
90In every keymap folder, the following files are recommended: 90In every keymap folder, the following files are recommended:
91 91
@@ -215,7 +215,7 @@ For a value of `4` for this imaginary setting. So we `undef` it first, then `def
215 215
216You can then override any settings, rather than having to copy and paste the whole thing. 216You can then override any settings, rather than having to copy and paste the whole thing.
217 217
218## Editing your keymap 218## Going beyond the keycodes
219 219
220Aside from the [basic keycodes](doc/keycode.txt), your keymap can include shortcuts to common operations. 220Aside from the [basic keycodes](doc/keycode.txt), your keymap can include shortcuts to common operations.
221 221
@@ -564,7 +564,7 @@ You can currently send 4 hex digits with your OS-specific modifier key (RALT for
564 564
565Enable the backlight from the Makefile. 565Enable the backlight from the Makefile.
566 566
567# Custom Quantum functions for keyboards and keymaps 567# Custom Quantum functions
568 568
569All of these functions are available in the `*_kb()` or `*_user()` variety. `kb` ones should only be used in the `<keyboard>/<keyboard>.c` file, and `user` ones should only be used in the `keymap.c`. The keyboard ones call the user ones - it's necessary to keep these calls to allow the keymap functions to work correctly. 569All of these functions are available in the `*_kb()` or `*_user()` variety. `kb` ones should only be used in the `<keyboard>/<keyboard>.c` file, and `user` ones should only be used in the `keymap.c`. The keyboard ones call the user ones - it's necessary to keep these calls to allow the keymap functions to work correctly.
570 570
@@ -613,8 +613,9 @@ This gets called whenever there is a state change on your host LEDs (eg caps loc
613 613
614and can be tested against the `usb_led` with a conditional like `if (usb_led & (1<<USB_LED_CAPS_LOCK))` - if this is true, you can turn your LED one, otherwise turn it off. 614and can be tested against the `usb_led` with a conditional like `if (usb_led & (1<<USB_LED_CAPS_LOCK))` - if this is true, you can turn your LED one, otherwise turn it off.
615 615
616# Modding your keyboard
616 617
617# Audio output from a speaker 618## Audio output from a speaker
618 619
619Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any keyboard that allows access to the C6 port, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes. 620Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any keyboard that allows access to the C6 port, you can hook up a simple speaker and make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
620 621
@@ -663,15 +664,15 @@ This is inside one of the macros. So when that macro executes, your keyboard pla
663 664
664"Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes. 665"Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes.
665 666
666# MIDI functionalty 667## MIDI functionalty
667 668
668This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile. 669This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
669 670
670# Bluetooth functionality 671## Bluetooth functionality
671 672
672This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will. 673This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
673 674
674# International Characters on Windows 675## International Characters on Windows
675 676
676[AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others. 677[AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others.
677 678
@@ -691,7 +692,7 @@ In the default script of AutoHotkey you can define custom hotkeys.
691The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a. 692The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a.
692AutoHotkey inserts the Text right of `Send, ` when this combination is pressed. 693AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
693 694
694# RGB Under Glow Mod 695## RGB Under Glow Mod
695 696
696![Planck with RGB Underglow](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg) 697![Planck with RGB Underglow](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
697 698
@@ -721,7 +722,7 @@ You'll need to edit `PORTF`, `DDRF`, and `PF4` on the first three lines to the p
721 722
722The firmware supports 5 different light effects, and the color (hue, saturation, brightness) can be customized in most effects. To control the underglow, you need to modify your keymap file to assign those functions to some keys/key combinations. For details, please check this keymap. `keyboards/planck/keymaps/yang/keymap.c` 723The firmware supports 5 different light effects, and the color (hue, saturation, brightness) can be customized in most effects. To control the underglow, you need to modify your keymap file to assign those functions to some keys/key combinations. For details, please check this keymap. `keyboards/planck/keymaps/yang/keymap.c`
723 724
724## WS2812 Wiring 725### WS2812 Wiring
725 726
726![WS2812 Wiring](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/WS2812-wiring.jpg) 727![WS2812 Wiring](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/WS2812-wiring.jpg)
727 728