qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2302B)

      1 # Acheron Elongate rev. Beta QMK firmware repository
      2 
      3 ![](https://i.imgur.com/G9LESkUh.jpg)
      4 
      5 * Keyboard Maintainer: [Gondolindrim](https://github.com/Gondolindrim)
      6 * Hardware Supported: [open-source PCB](https://github.com/AcheronProject/Elongate) powered by STM32F072 microcontroller
      7 * Hardware Availability: the revision beta of Elongate was never publicly sold.
      8 
      9 ## Introduction
     10 
     11 This is the QMK firmware repository for the Elongate PCB revision Beta and pre-revision Beta versions, which was the initial revision PCB for this keyboard; hence it was never sold publicly.
     12 
     13 The Elongate PCB is an Open-Hardware-guideline-compliant PCB which files can be found at [this repository](https://github.com/AcheronProject/Elongate). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim).
     14 
     15 ## How to flash
     16 
     17 ### Enter bootloader
     18 
     19 The DFU state in the bootloader can be accessed in 3 ways:
     20 
     21 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
     22 * **Physical reset button**: press the button on the front of the PCB.
     23 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.
     24 
     25 ## Compile firmware
     26 
     27 You can build the default layout firwmare for Elongate after setting up your build environment by using:
     28 
     29     make acheron/elongate/beta:default
     30 
     31 After entering DFU state in your PCB, you can download the binary file generated through `dfu-util` or a GUI like QMK Toolbox.
     32 
     33 To directly flash the PCB after it is put into a DFU state, use
     34 
     35     make acheron/elongate/beta:default:flash
     36 
     37 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).
     38 
     39 ## PCB Documentation
     40 
     41 See the [AcheronDocs](https://acheronproject.com/pcbs/elongate/) page for the ElongatePCB full documentation. You can also check the KiCad PCB files at the [Elongate GitHub repository](https://github.com/AcheronProject/Elongate).
     42 
     43 Before using the files for personal or commercial use, please read the [Acheron Open-Hardware License V1.4](https://acheronproject.com/AOHL14/) under which the Elongate PCB is published.