aboutsummaryrefslogtreecommitdiff
path: root/keyboards/sneakbox/aliceclonergb/readme.md
diff options
context:
space:
mode:
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 000000000..dc4291bcd
--- /dev/null
+++ b/keyboards/sneakbox/aliceclonergb/readme.md
@@ -0,0 +1,23 @@
1# Sneakbox Alice Clone RGB PCB
2
3![Sneakbox Alice Clone RGB PCB](https://i.imgur.com/pMZNqLXl.jpg)
4
5An 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.
6
7* Keyboard Maintainer: [mujimanic](https://github.com/mujimanic)
8* Hardware Supported: Any Alice-layout case.
9* Hardware Availability: [sneakbox.design](https://sneakbox.design/products/sneakbox-alice-hotswap-pcbs)
10
11Make example for this keyboard (after setting up your build environment):
12
13 make sneakbox/aliceclonergb:default
14
15See 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).
16
17## Bootloader
18
19Enter the bootloader in 3 ways:
20
21* **Bootmagic reset**: Hold down the top left key in the nevigation cluster (Escape key) and plug in the keyboard
22* **Physical reset button**: Briefly press the small metal button on the back of the PCB
23* **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)