aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorWojciech Siewierski <wojciech.siewierski@onet.pl>2016-08-19 00:17:57 +0200
committerWojciech Siewierski <wojciech.siewierski@onet.pl>2016-08-19 00:18:45 +0200
commitea7115534afb23571f11af38c19b4835e1699c7e (patch)
treecb59c9eb802891ba69895369698130e20d1f9636 /readme.md
parent6c359cabbf2f8d0b0e363701cecf61653e8f78a2 (diff)
downloadqmk_firmware-ea7115534afb23571f11af38c19b4835e1699c7e.tar.gz
qmk_firmware-ea7115534afb23571f11af38c19b4835e1699c7e.zip
Improve the dynamic macro documentation
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 119995a5c..37f140839 100644
--- a/readme.md
+++ b/readme.md
@@ -721,7 +721,7 @@ Below these two modifications include the `dynamic_macro.h` header:
721 721
722 #include "dynamic_macro.h"` 722 #include "dynamic_macro.h"`
723 723
724Then define the `_DYN` layer with the following keys: `DYN_REC_START1`, `DYN_REC_PLAY1`,`DYN_REC_START2` and `DYN_REC_PLAY2`. It may also contain other keys, it doesn't matter apart from the fact that you won't be able to record these keys in the dynamic macros. 724Then define the `_DYN` layer with the following keys: `DYN_REC_START1`, `DYN_MACRO_PLAY1`,`DYN_REC_START2` and `DYN_MACRO_PLAY2`. It may also contain other keys, it doesn't matter apart from the fact that you won't be able to record these keys in the dynamic macros.
725 725
726 [_DYN]= { 726 [_DYN]= {
727 {_______, DYN_REC_START1, DYN_MACRO_PLAY1, _______, _______, _______, _______, _______, _______, _______, _______, _______}, 727 {_______, DYN_REC_START1, DYN_MACRO_PLAY1, _______, _______, _______, _______, _______, _______, _______, _______, _______},
@@ -736,7 +736,11 @@ Add the following code to the very beginning of your `process_record_user()` fun
736 return false; 736 return false;
737 } 737 }
738 738
739The usage should be pretty self-explanatory. For the details, please read the comments in the `dynamic_macro.h` header. 739To start recording the macro, press either `DYN_REC_START1` or `DYN_REC_START2`. To finish the recording, press the `_DYN` layer button. The handler awaits specifically for the `MO(_DYN)` keycode as the "stop signal" so please don't use any fancy ways to access this layer, use the regular `MO()` modifier. To replay the macro, press either `DYN_MACRO_PLAY1` or `DYN_MACRO_PLAY2`.
740
741If the LED-s start blinking during the recording with each keypress, it means there is no more space for the macro in the macro buffer. To fit the macro in, either make the other macro shorter (they share the same buffer) or increase the buffer size by setting the `DYNAMIC_MACRO_SIZE` preprocessor macro (default value: 256; please read the comments for it in the header).
742
743For the details about the internals of the dynamic macros, please read the comments in the `dynamic_macro.h` header.
740 744
741## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc) 745## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
742 746