readme.md (2626B)
1 # Acheron Apollo QMK firmware 2 3  4 5 The Apollo is Acheron Project's family of open-source, freely available tenkeyless (TKL) keyboard Printed Circuit Boards (PCB) which main feature is the per-key RGB lighting. 6 7 * Keyboard Maintainer: [Gondolindrim](https://github.com/Gondolindrim) 8 * Hardware Supported: open-source PCB using the [Joker template](https://acheronproject.com/joker_mcus/joker/). First units were manufactured using STM32F401 microcontroller; 9 * 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. 10 11 As of april 7, 2022, Apollo comes in three different layouts: 12 13 - 87H (default ANSI) 14 - 87H-T-SC (ANSI with tsangan bottom row and stepped caps); 15 - 88H-T-SC (ANSI with F13, tsangan bottom row and stepped caps); 16 17 See each variant's README for more information on flashing. 18 19 ## Flashing instructions 20 21 ### Step 1: enter bootloader 22 23 The DFU state in the bootloader can be accessed in 3 ways: 24 25 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard 26 * **Physical reset button**: press the physical button on the back of the PCB for at least five seconds 27 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available (ESC key at layer 1 in the default layout) 28 29 ### Step 2: compile firmware 30 31 After accessing the DFU state in your PCB, build the default layout using: 32 33 make acheron/apollo/87h/gamma:default # For 87H revision Gamma 34 make acheron/apollo/87h/delta:default # For 87H revision Delta 35 make acheron/apollo/87htsc:default # For 87H-T-SC (only a single revision as of may 2022) 36 make acheron/apollo/88htsc:default # For 88H-T-SC (only a single revision as of may 2022) 37 38 ### Step 3: flashing 39 40 You can use a flashing tool like `dfu-util` or QMK Toolbox to download the resulting `*.bin` file into your PCB. 41 42 ### (Alternative) Compile and flash 43 44 After accessing the DFU state in your PCB, you can compile-and-flash automatically using `dfu-util` through 45 46 make acheron/apollo/<variant>:default:flash 47 48 ### VIA firmware 49 50 When compiling, just substitute `default` for `via`. 51 52 ## Additional info 53 54 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).