summaryrefslogtreecommitdiffstats
path: root/keyboards/tzarc/djinn/readme.md
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2022-06-20 14:20:56 +1000
committerGitHub <noreply@github.com>2022-06-20 14:20:56 +1000
commitaa06893b58ac3ed88e796968d237f60f4c156875 (patch)
treead4b3a637b7bba88de772dd50150262d2992603e /keyboards/tzarc/djinn/readme.md
parentad2e85361128a2252798a7bb4c1cbc0bcd58e8ab (diff)
Add Djinn. (#17382)
* Add Djinn. * Review comments. * Further cleanup.
Diffstat (limited to 'keyboards/tzarc/djinn/readme.md')
-rw-r--r--keyboards/tzarc/djinn/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/tzarc/djinn/readme.md b/keyboards/tzarc/djinn/readme.md
new file mode 100644
index 0000000000..5cb9e9339c
--- /dev/null
+++ b/keyboards/tzarc/djinn/readme.md
@@ -0,0 +1,27 @@
+# Djinn
+
+![Djinn](https://i.imgur.com/ArSjkv8.jpg)
+
+The Djinn is a 64-key split keyboard -- dual 4x7 with a 4-key thumb cluster and encoders. It also has a 5-way tactile switch under the thumb. Oh, and two displays.
+
+Keyboard Maintainer: [tzarc](https://github.com/tzarc)
+Hardware Supported: Djinn: rev1, rev2
+Hardware Availability: [Open-source](https://github.com/tzarc/djinn)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make tzarc/djinn/rev2:default
+
+Flashing example for this keyboard:
+
+ make tzarc/djinn/rev2:default:flash
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top-left key and plug in the keyboard.
+* **Physical reset button**: Briefly press the button on the back of the PCB.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.