summaryrefslogtreecommitdiffstats
path: root/keyboards/atlantis/ak81_ve/readme.md
diff options
context:
space:
mode:
authorfOmey <pauly.galea@gmail.com>2022-01-14 05:59:16 +1100
committerGitHub <noreply@github.com>2022-01-13 10:59:16 -0800
commit8a6da095d22d66c0ba36ce8731c9d821ca4262e9 (patch)
tree8b114aba7ee61982cd7e841199abe27490191df6 /keyboards/atlantis/ak81_ve/readme.md
parent6770f77270d028a3d72f28e7891bb5213fdbae24 (diff)
[Keyboard] Atlantis AK81_VE support (#15392)
Diffstat (limited to 'keyboards/atlantis/ak81_ve/readme.md')
-rw-r--r--keyboards/atlantis/ak81_ve/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/atlantis/ak81_ve/readme.md b/keyboards/atlantis/ak81_ve/readme.md
new file mode 100644
index 0000000000..d9a6f9627c
--- /dev/null
+++ b/keyboards/atlantis/ak81_ve/readme.md
@@ -0,0 +1,23 @@
+# ATLANTIS AK81_VE
+
+![ATLANTIS AK81_VE](https://i.imgur.com/nfuocgS.jpeg)
+
+A 75% hotswap keyboard with per key RGB backlighting, RGB underglow and a rotary encoder.
+
+* Keyboard Maintainer: [fOmey](https://github.com/fOmey)
+* Hardware Supported: AK75X@AK81_VE
+* Hardware Availability: [AliExpress.com](https://aliexpress.com), [Shopee](https://shopee.com.my)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make atlantis/ak81_ve:default
+
+## Bootloader
+
+Enter the bootloader in 2 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+* **Physical reset pins**: Briefly short the reset pins using tweezers, a paperclip, or any other conductive material.
+
+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). \ No newline at end of file