summaryrefslogtreecommitdiff
path: root/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
diff options
context:
space:
mode:
authorcasuanoob <96005765+casuanoob@users.noreply.github.com>2023-10-02 04:55:54 +1100
committerGitHub <noreply@github.com>2023-10-01 18:55:54 +0100
commit1b7a538353347e564edce2c78a7b155a50ac3c4b (patch)
tree29bee764363860c21573bc59504b5246b987e00c /keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
parent8813bdf5ddfc9fdcbcaf7d4bddb44f7673dbfe9e (diff)
Bastard Keyboards: Add support for Dilemma Max (4x6_4) (#22064)
* tentatively add dilemma 4x6_4 WIP untested PR by Casuanoob. Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md')
-rw-r--r--keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md b/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
new file mode 100644
index 0000000000..f3636c8a40
--- /dev/null
+++ b/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
@@ -0,0 +1,47 @@
+# Dilemma Max `via` keymap
+
+The Dilemma Max `via` keymap is based on the original [Dactyl Manuform](../../../../../handwired/dactyl_manuform) default keymap, with some features and changes specific to the Dilemma.
+
+This layout also supports VIA.
+
+## Customizing the keymap
+
+### Dynamic DPI scaling
+
+Use the following keycodes to change the default DPI:
+
+- `POINTER_DEFAULT_DPI_FORWARD`: increases the DPI; decreases when shifted;
+- `POINTER_DEFAULT_DPI_REVERSE`: decreases the DPI; increases when shifted.
+
+There's a maximum of 16 possible values for the sniping mode DPI. See the [Dilemma documentation](../../README.md) for more information.
+
+Use the following keycodes to change the sniping mode DPI:
+
+- `POINTER_SNIPING_DPI_FORWARD`: increases the DPI; decreases when shifted;
+- `POINTER_SNIPING_DPI_REVERSE`: decreases the DPI; increases when shifted.
+
+There's a maximum of 4 possible values for the sniping mode DPI. See the [Dilemma documentation](../../README.md) for more information.
+
+### Drag-scroll
+
+Use the `DRAGSCROLL_MODE` keycode to enable drag-scroll on hold. Use the `DRAGSCROLL_TOGGLE` keycode to enable/disable drag-scroll on key press.
+
+### Circular scroll
+
+By default, the firmware is configured to enable the circular scroll feature on Cirque trackpad.
+
+To disable this, add the following to your keymap:
+
+```c
+#undef POINTING_DEVICE_GESTURES_SCROLL_ENABLE
+```
+
+### Sniping
+
+Use the `SNIPING_MODE` keycode to enable sniping mode on hold. Use the `SNIPING_TOGGLE` keycode to enable/disable sniping mode on key press.
+
+Change the value of `DILEMMA_AUTO_SNIPING_ON_LAYER` to automatically enable sniping mode on layer change. By default, sniping mode is enabled on the pointer layer:
+
+```c
+#define DILEMMA_AUTO_SNIPING_ON_LAYER LAYER_POINTER
+```