diff options
Diffstat (limited to 'keyboards/aplx6/readme.md')
-rw-r--r-- | keyboards/aplx6/readme.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/keyboards/aplx6/readme.md b/keyboards/aplx6/readme.md new file mode 100644 index 000000000..55e73ea2d --- /dev/null +++ b/keyboards/aplx6/readme.md | |||
@@ -0,0 +1,41 @@ | |||
1 | # Aplx6 | ||
2 | |||
3 |  | ||
4 |  | ||
5 | |||
6 | A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes. | ||
7 | |||
8 | |||
9 | ## RGB Underglow (WS2812) | ||
10 | |||
11 | Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod. | ||
12 | |||
13 | * Keyboard Maintainer: [Aplyard](https://github.com/Aplyard) | ||
14 | * Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4) | ||
15 | * Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6) | ||
16 | |||
17 | Make example for this keyboard (after setting up your build environment): | ||
18 | |||
19 | make aplx6:default | ||
20 | |||
21 | 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). | ||
22 | |||
23 | --- | ||
24 | ****Designed in**:** | ||
25 | [KiCad](https://github.com/KiCad) | ||
26 | |||
27 | **Components Footprints & Libraries :** | ||
28 | [keebs.pretty](https://github.com/egladman/keebs.pretty) | ||
29 | [keyboard_parts.pretty | ||
30 | ](https://github.com/tmk/keyboard_parts.pretty) | ||
31 | [ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad) | ||
32 | |||
33 | **Usefull Links:** | ||
34 | [Qmk Online Configurator](https://config.qmk.fm/#) | ||
35 | |||
36 | **Alternatives of qmk that worked for me:** | ||
37 | [Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/) | ||
38 | [Keyboard Plate & Case Builder](http://builder.swillkb.com/) | ||
39 | [Firmware Builder](https://kbfirmware.com/) | ||
40 | |||
41 | --- | ||