From b048a8af95aa456ce67c384933ac9ce1e29c3c65 Mon Sep 17 00:00:00 2001
From: rootiest <chris@rootiest.com>
Date: Mon, 2 Mar 2026 03:38:18 -0500
Subject: [PATCH] docs: add basic readme

Add an initial README file to list the default shortcut keys
---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..664c677
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# Keychron Q5 Max (QMK/VIA) Default Shortcuts
+
+The Keychron Q5 Max uses a "Layer" system. By default:
+- **Layer 0/1:** Mac Mode (Toggle switch on the back)
+- **Layer 2/3:** Windows/Linux Mode (Toggle switch on the back)
+
+## 🔋 Battery & Connectivity
+| Shortcut | Action | Description |
+| :--- | :--- | :--- |
+| `Fn` + `B` | **Battery Status** | Backlight indicates charge (Green/Blue/Red). |
+| `Fn` + `1` | **Bluetooth Device 1** | Short press to switch, long press (3s) to pair. |
+| `Fn` + `2` | **Bluetooth Device 2** | Short press to switch, long press (3s) to pair. |
+| `Fn` + `3` | **Bluetooth Device 3** | Short press to switch, long press (3s) to pair. |
+| `Fn` + `4` | **2.4GHz Mode** | Switch to the USB Receiver (Dongle) mode. |
+| `Fn` + `J` + `Z` | **Factory Reset** | Hold for 3 seconds to wipe EEPROM and reset. |
+
+## 💡 RGB Lighting Controls
+| Shortcut | Action | Description |
+| :--- | :--- | :--- |
+| `Fn` + `Q` | **Next Effect** | Cycle through RGB animation modes. |
+| `Fn` + `A` | **Previous Effect** | Cycle backward through RGB modes. |
+| `Fn` + `W` | **Brightness Up** | Increase backlight intensity. |
+| `Fn` + `S` | **Brightness Down** | Decrease backlight intensity. |
+| `Fn` + `E` | **Hue Increase** | Cycle through the color spectrum. |
+| `Fn` + `D` | **Hue Decrease** | Cycle backward through the spectrum. |
+| `Fn` + `R` | **Saturation Up** | Make colors more vivid. |
+| `Fn` + `F` | **Saturation Down** | Make colors more pastel/white. |
+| `Fn` + `T` | **Effect Speed Up** | Increase animation frequency. |
+| `Fn` + `G` | **Effect Speed Down** | Decrease animation frequency. |
+
+## 🛠 Function & System Keys
+| Shortcut | Action | Description |
+| :--- | :--- | :--- |
+| `Fn` + `X` + `L` | **Function Toggle** | Switch between F1-F12 and Media keys (top row). |
+| `Fn` + `K` + `C` | **Knob Mode** | (If supported) Change knob between Volume/Brightness. |
+| `Fn` + `M` | **Menu/App Key** | Standard Context Menu key (Linux/Windows). |
+| `Fn` + `I` | **Print Screen** | Capture screen (useful for Spectacle on KDE). |
+| `Fn` + `O` | **Scroll Lock** | Standard Scroll Lock. |
+| `Fn` + `P` | **Pause/Break** | Standard Pause key. |
+
+---
+*Note: Since you build from source, you can re-map these in your `keymap.c` or via the VIA/Vial web interface.*