From 5b907a821d231d04cac269af8071409966a83c06 Mon Sep 17 00:00:00 2001
From: wochap <wochap@noreply.codeberg.org>
Date: Tue, 12 Mar 2024 17:31:26 +0000
Subject: [PATCH] Add modes

---
 modes.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 modes.md

diff --git a/modes.md b/modes.md
new file mode 100644
index 0000000..2c3c27b
--- /dev/null
+++ b/modes.md
@@ -0,0 +1,35 @@
+### Description
+Implement  modes, that way each mapping is associated with a mode and is only active while in that mode, default mode is `NORMAL`
+
+### Example
+
+In the example below, you declare a mode: `BROWSER`, which is activated when you press <kbd>modkey</kbd> + <kbd>b</kbd>. Then, you can press <kbd>f</kbd> to launch `Firefox` and return to the default `NORMAL` mode.
+
+```c
+enum {
+  BROWSER,
+};
+const char *modes_labels[] = {
+  "browser",
+};
+
+static const Key keys[] = {
+  // ...
+  { MODKEY, XKB_KEY_b, entermode, {.i = BROWSER} },
+  // ...
+};
+
+static const Modekey modekeys[] = {
+  /* mode      modifier                  key                 function        argument */
+  { BROWSER, { 0, XKB_KEY_f, spawn, SHCMD("firefox") } },
+  { BROWSER, { 0, XKB_KEY_f, entermode, {.i = NORMAL} } },
+  { BROWSER, { 0, XKB_KEY_Escape, entermode, {.i = NORMAL} } },
+};
+```
+
+### Download
+- [git branch](https://codeberg.org/wochap/dwl/src/branch/v0.5/modes)
+- [2024-03-12](https://codeberg.org/dwl/dwl-patches/raw/branch/main/modes/modes.patch)
+
+### Authors
+- [wochap](https://codeberg.org/wochap)