From ebd209d285ffdad5d56098c8d4edb6f2f364c907 Mon Sep 17 00:00:00 2001 From: dragon788 Date: Sat, 16 Jan 2016 20:46:15 -0600 Subject: Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 55fb76798b..33005227df 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ The documentation below explains QMK customizations and elaborates on some of th ## Getting started * **If you're looking to customize a keyboard that currently runs QMK or TMK** , find your keyboard's directory under `/keyboard/` and read the README file. This will get you all set up. +* Read the [QUICK_START.md](QUICK_START.md) if you want to hit the ground running with minimal fuss or you aren't a technical person and you just want to build the firmware with the least amount of hassle possible. * If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh `, which will create `/keyboard/` with all the necessary components for a Quantum project. You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you. -- cgit v1.2.3 From 783eafac6e181fb6225d894edc083cdc3bfae9c8 Mon Sep 17 00:00:00 2001 From: Peter Eichinger Date: Mon, 18 Jan 2016 22:31:36 +0100 Subject: Readme for LCAG modifier combo and international characters with AutoHotkey --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 55fb76798b..1274c402d7 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ Your keymap can include shortcuts to common operations (called "function actions * `RGUI(kc)` - applies right GUI (command/win) to *kc* * `HYPR(kc)` - applies Hyper (all modifiers) to *kc* * `MEH(kc)` - applies Meh (all modifiers except Win/Cmd) to *kc* +* `LCAG(kc)` - applies CtrlAltGui to *kc* You can also chain these, like this: @@ -89,6 +90,7 @@ We've added shortcuts to make common modifier/tap (mod-tap) mappings more compac * `ALT_T(kc)` - is LALT when held and *kc* when tapped * `GUI_T(kc)` - is LGUI when held and *kc* when tapped * `ALL_T(kc)` - is Hyper (all mods) when held and *kc* when tapped. To read more about what you can do with a Hyper key, see [this blog post by Brett Terpstra](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/) + * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift. ### Temporarily setting the default layer @@ -175,3 +177,23 @@ This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happeni ## Bluetooth functionality This 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. + +## International Characters on Windows + +[AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys amont others. + +The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background. + +First you need to select a modifier combination that is not in use by any of your programs. +CtrlAltWin is not used very widely and should therefore be perfect for this. +There is a macro defined for a mod-tab combo `LCAG_T`. +Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`. +This makes the key behave like a tab key if pressed and released immediately but changes it to the modifier if used with another key. + +In the default script of AutoHotkey you can define custom hotkeys. + + <^ Date: Mon, 18 Jan 2016 22:33:26 +0100 Subject: Fix code formatting in international characters readme entry --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1274c402d7..f46bd68e26 100644 --- a/README.md +++ b/README.md @@ -192,8 +192,8 @@ This makes the key behave like a tab key if pressed and released immediately but In the default script of AutoHotkey you can define custom hotkeys. - <^