summaryrefslogtreecommitdiff
path: root/keyboards/nopunin10did/jabberwocky/v1/readme.md
diff options
context:
space:
mode:
authornopunin10did <w.alex.ronke@gmail.com>2022-11-19 14:35:35 -0500
committerGitHub <noreply@github.com>2022-11-19 11:35:35 -0800
commit0bf72e4fe52c7458a0c1376647af2aa53901f6ee (patch)
treea6b3f617d446504fbcf1a3f8448962abd406220c /keyboards/nopunin10did/jabberwocky/v1/readme.md
parent5d882ab6ef6bc3cf384046f409a86cbb7550153c (diff)
[Keyboard] Add Jabberwocky v2 and reorganize (#19014)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/nopunin10did/jabberwocky/v1/readme.md')
-rw-r--r--keyboards/nopunin10did/jabberwocky/v1/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/nopunin10did/jabberwocky/v1/readme.md b/keyboards/nopunin10did/jabberwocky/v1/readme.md
new file mode 100644
index 0000000000..8c845064de
--- /dev/null
+++ b/keyboards/nopunin10did/jabberwocky/v1/readme.md
@@ -0,0 +1,30 @@
+# Jabberwocky
+
+![Jabberwocky](https://diplomacyvariants.files.wordpress.com/2021/03/dexterous_jabberwocky.jpg)
+
+A full-size, columnar-staggered, Alice-style keyboard. The Jabberwocky comes in two varieties currently:
+* Dexterous (with numpad on the right side, pictured above)
+* Sinister (with numpad on the left side)
+
+Both the v1 Dexterous and v1 Sinister use the same firmware. The numpad and the four keys above it are simply transposed from the right to the left side of the board.
+
+For more information, join the [NoPunIn10Key Discord](https://discord.gg/sku2Y6w).
+
+* Keyboard Maintainer: [Alex Ronke](https://nopunin10did.com/), also known as [NoPunIn10Did](https://github.com/NoPunIn10Did)
+* Hardware Supported: Dexterous Jabberwocky and Sinister Jabberwocky v1 (2021 March)
+* Hardware Availability: Currently by request only
+
+**The v1 firmware is not compatible with any of the second-generation v2 Jabberwocky PCBs. Please use the [v2 firmware](../v2/readme.md) instead.**
+
+To reset the board into bootloader mode, do one of the following:
+
+* If loaded with the default layout, use Function-Escape or Function-R *(the function buttons are the 1u keys next to B and N)*
+* Use the physical reset switch near the USB port *(if provided for your version of the board)*
+* Use the physical reset switch on the Elite C
+* Briefly jump the Reset and Ground pins of the Elite C
+
+Make example for this keyboard (after setting up your build environment):
+
+ make nopunin10did/jabberwocky/v1:default
+
+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).