summaryrefslogtreecommitdiff
path: root/keyboards/sneakbox/aliceclonergb/readme.md
diff options
context:
space:
mode:
authorSneakboxKB <67670271+SneakboxKB@users.noreply.github.com>2022-02-06 11:50:09 -0600
committerGitHub <noreply@github.com>2022-02-06 09:50:09 -0800
commite7a9e92a04c8279878756829a8a12401ba78abee (patch)
treee3d52e83236b8a0b7e548d3c53da5a5431b705cd /keyboards/sneakbox/aliceclonergb/readme.md
parent87199eb2f50522b7b91352e4b1c76d6db3f14af3 (diff)
[Keyboard] Add aliceclonergb (#14285)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: SneakboxKB <64090325+mujimanic@users.noreply.github.com>
Diffstat (limited to 'keyboards/sneakbox/aliceclonergb/readme.md')
-rw-r--r--keyboards/sneakbox/aliceclonergb/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/sneakbox/aliceclonergb/readme.md b/keyboards/sneakbox/aliceclonergb/readme.md
new file mode 100644
index 0000000000..dc4291bcdf
--- /dev/null
+++ b/keyboards/sneakbox/aliceclonergb/readme.md
@@ -0,0 +1,23 @@
+# Sneakbox Alice Clone RGB PCB
+
+![Sneakbox Alice Clone RGB PCB](https://i.imgur.com/pMZNqLXl.jpg)
+
+An Alice-compatible PCB with hotswap with pushbutton rotary encoder socket placed at the top left key position. This PCB is the successor to the v3 AliceClone PCB and features RGB underglow lighting along with revised hardware components.
+
+* Keyboard Maintainer: [mujimanic](https://github.com/mujimanic)
+* Hardware Supported: Any Alice-layout case.
+* Hardware Availability: [sneakbox.design](https://sneakbox.design/products/sneakbox-alice-hotswap-pcbs)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make sneakbox/aliceclonergb: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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key in the nevigation cluster (Escape key) and plug in the keyboard
+* **Physical reset button**: Briefly press the small metal button on the back of the PCB
+* **Keycode in layout**: Press and hold the key next to the right split spacebar (to the right of the spacebar) and then press the End key (located on the bottom of the four-key navigation cluster)