summaryrefslogtreecommitdiff
path: root/keyboards/acheron/apollo/87h/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-07-24 00:10:33 +0000
committerQMK Bot <hello@qmk.fm>2022-07-24 00:10:33 +0000
commit3825362a3b2fa9249cd7c809cd656dfce51b7cd3 (patch)
tree49e15ee06cf5927f48f59083f1d7feb85af36800 /keyboards/acheron/apollo/87h/readme.md
parentf383f7d6e57d674209249d36c169926105b58c9d (diff)
parent98c1f7a9ef569802ab3606eac098e388109f4025 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/acheron/apollo/87h/readme.md')
-rw-r--r--keyboards/acheron/apollo/87h/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/acheron/apollo/87h/readme.md b/keyboards/acheron/apollo/87h/readme.md
new file mode 100644
index 0000000000..f00dae4450
--- /dev/null
+++ b/keyboards/acheron/apollo/87h/readme.md
@@ -0,0 +1,25 @@
+# Acheron Apollo87H QMK firmware
+
+![apollo](https://acheronproject.com/images/apollo/delta-pictures/delta1_small.jpeg)
+
+The Apollo87H is Acheron Project's open-source, freely available tenkeyless (TKL) keyboard Printed Circuit Boards (PCB) which features:
+
+- Per-key RGB lighting
+- Hotswap sockets
+- ANSI default layout with F12 and 6.25 units spacebar.
+
+* Keyboard Maintainer: [Gondolindrim](https://github.com/Gondolindrim)
+* Hardware Supported: open-source PCB using the [Joker template](https://acheronproject.com/joker_mcus/joker/). First units were manufactured using STM32F401 microcontroller;
+* Hardware Availability: these PCBs are open-source so you can manufacture them yourself or order them from a factory. See the [project's documentation](https://acheronproject.com/pcbs/apollo/apollo/) for more information.
+
+In order to flash this PCB, first build the default layout (after setting up your build environment):
+
+ make acheron/apollo/87h/<revision>:default
+
+Where `revision` is the revision of your PCB. Two revisions were prototyped and sold: _Gamma_ and _Delta_. Look into the label on the PCB's back to see what revision is yours. Ready-to-use binaries for the default and the VIA layouts are available in the release pages of the [project's repository](https://github.com/AcheronProject/Apollo87H).
+
+After building or downloading the firmware, put the PCB into DFU mode by holding the reset button for at least five seconds and upload the firmware onto the microcontroller through a utility like `dfu-util` or QMK Toolbox. Alternatively, you can build and flash using:
+
+ make acheron/apollo/87h/<revision>:default:flash
+
+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).