aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/aplx6/README.md
diff options
context:
space:
mode:
authorGravatar Aplyard <40563350+Aplyard@users.noreply.github.com>2020-04-13 22:13:41 +0300
committerGravatar GitHub <noreply@github.com>2020-04-13 12:13:41 -0700
commit4bccde37d4148bdf0ee3676c9eed102639cfeb4a (patch)
tree108db12c042ff59b0be75fab718a26aab381c983 /keyboards/aplx6/README.md
parentf6b40da7f854d461f30a3e525f4e36e51dac5db4 (diff)
downloadqmk_firmware-4bccde37d4148bdf0ee3676c9eed102639cfeb4a.tar.gz
[Keyboard] Aplx6 (#8727)
* Create test.txt * aplx6 * Delete test.txt * fff * Delete ffff * test compile * Create README.md * edited * requests * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/rules.mk * Update keyboards/aplx6/rules.mk * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * pins update * update * update pins * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md
Diffstat (limited to 'keyboards/aplx6/README.md')
-rw-r--r--keyboards/aplx6/README.md41
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 @@
+# Aplx6
+
+![Front](https://i.imgur.com/flhSvAG.png)
+![Back](https://i.imgur.com/PXqNmUh.png)
+
+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.
+
+
+## RGB Underglow (WS2812)
+
+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.
+
+* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard)
+* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4)
+* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make aplx6: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).
+
+---
+****Designed in**:**
+[KiCad](https://github.com/KiCad)
+
+**Components Footprints & Libraries :**
+[keebs.pretty](https://github.com/egladman/keebs.pretty)
+[keyboard_parts.pretty
+](https://github.com/tmk/keyboard_parts.pretty)
+[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad)
+
+**Usefull Links:**
+[Qmk Online Configurator](https://config.qmk.fm/#)
+
+**Alternatives of qmk that worked for me:**
+[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/)
+[Keyboard Plate & Case Builder](http://builder.swillkb.com/)
+[Firmware Builder](https://kbfirmware.com/)
+
+---