diff options
| author | Álvaro A. Volpato <alvaro.augusto.volpato@gmail.com> | 2022-07-23 21:09:52 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-23 17:09:52 -0700 |
| commit | 98c1f7a9ef569802ab3606eac098e388109f4025 (patch) | |
| tree | 77dea98215e6ecf2ce765f45069f23303f9af1e2 /keyboards/acheron/apollo/87h/readme.md | |
| parent | c3df1775bc9a14b5a43c03d000f6765c119b44ee (diff) | |
[Keyboard] Apollo87H PCB support (#16817)
* Initial Apollo87H support
* Define RGB animations and default animation
* Add proper per-key RGB support
* Adjust LED positions
* Separate delta-gamma
* Fine-tune LED positions
* fix up GAMMA revision
* fix up tabs indentation to spaces indentation
* Fixed positioning and CS-SW defs for some LEDs
* Fix INS RGB position
* Fine-tune LED positions, fix default RGB
* Update readme's
* Rename LAYOUT_87H to lowercase 87h
* Formatting gamma's rules.mk
* Formatting delta's rules.mk
* Use smaller readme image
* Use smaller README image
* First support for 87H-T-SC and 88H-T-SC
* Update README
* Fix layout naming
* Remove
* Remove EEPROM definitions, fix missing RGB LED mod/alpha definer
* Add suggestions from noroadsleft
Diffstat (limited to 'keyboards/acheron/apollo/87h/readme.md')
| -rw-r--r-- | keyboards/acheron/apollo/87h/readme.md | 25 |
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 + + + +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). |