From df111a55b9d4929182e16108b1c0ead15b16df97 Mon Sep 17 00:00:00 2001 From: Chris Lewis Date: Tue, 11 Sep 2018 09:21:27 +1000 Subject: [PATCH] Update feature documentation --- docs/feature_velocikey.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/feature_velocikey.md b/docs/feature_velocikey.md index 870abbcaa4..5d98410735 100644 --- a/docs/feature_velocikey.md +++ b/docs/feature_velocikey.md @@ -3,7 +3,17 @@ Velocikey is a feature that lets you control the speed of lighting effects (like the Rainbow Swirl effect) with the speed of your typing. The faster you type, the faster the lights will go! ## Usage -For Velocikey to take effect, you need to enable it with the VLK_TOG keycode, which toggles it on and off. +For Velocikey to take effect, there are two steps. First, when compiling your keyboard, you'll need to set `VELOCIKEY_ENABLE=yes` in `rules.mk`, e.g.: + +``` +BOOTMAGIC_ENABLE = no +MOUSEKEY_ENABLE = no +STENO_ENABLE = no +EXTRAKEY_ENABLE = yes +VELOCIKEY_ENABLE = yes +``` + +Then, while using your keyboard, you need to also turn it on with the VLK_TOG keycode, which toggles the feature on and off. The following light effects will all be controlled by Velocikey when it is enabled: - RGB Breathing @@ -17,4 +27,4 @@ Support for LED breathing effects is planned but not available yet. As long as Velocikey is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on. ## Configuration - Velocikey doesn't currently support any configuration via keyboard settings. If you want to adjust something like the speed increase or decay rate, you would need to edit `velocikey.c` and adjust the values there to achieve the kinds of speeds that you like. \ No newline at end of file + Velocikey doesn't currently support any configuration via keyboard settings. If you want to adjust something like the speed increase or decay rate, you would need to edit `velocikey.c` and adjust the values there to achieve the kinds of speeds that you like.