qmk_firmware

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

readme.md (2138B)

      1 # Anne Pro 2 rev. C15 and C18 QMK firmware
      2 
      3 An ANSI-layout 60% keyboard featuring Bluetooth support and per-key RGB lighting.
      4 
      5 * Keyboard Maintainer: [bwisn](https://github.com/bwisn)
      6 * Hardware Supported: Anne Pro 2, [C15](c15/) and [C18](c18/) versions
      7 * Hardware Availability: [annepro.net](https://www.annepro.net/), [Hexcore](https://www.hexcore.xyz/annepro2)
      8 
      9 ## How to compile
     10 
     11 After setting up your build environment, you can compile the Anne Pro 2 C18 default keymap by using:
     12 
     13     make annepro2/c18:default
     14 
     15 If you want to compile the Anne Pro 2 C15 default keymap use:
     16 
     17     make annepro2/c15:default
     18 
     19 ## Installing
     20 
     21 ### Get AnnePro2 Tools
     22 
     23 If you want the executable instead of compiling it yourself, [download it here](https://ci.codetector.org/job/OpenAnnePro/job/AnnePro2-Tools/job/master/).
     24 Windows and Linux versions are available. Otherwise, follow the steps below:
     25 
     26 1. Install the latest stable `rust` toolchain using [rustup](https://rustup.rs/)
     27 1. Also install [Visual Studio Community edition](https://visualstudio.microsoft.com/downloads/)
     28 including the C/C++ module to prevent errors while compiling
     29 1. Download or Clone the [AnnePro2-Tools](https://github.com/OpenAnnePro/AnnePro2-Tools) project.
     30 1. Compile the tool using
     31    ```bash
     32    cargo build --release
     33    ```
     34    The compiled tool should be in `./target/release/annepro2_tools` (In later I will refer to this as `annepro2_tools`)
     35 
     36 ### Flashing the firmware
     37 
     38 1. Put the keyboard into DFU/IAP mode by unplugging the keyboard, then holding ESC while plugging it back in.
     39 1. Run annepro2_tools with the firmware you just built.  
     40    **Please substitute with the correct paths and correct bin file if you chose another keymap profile.**
     41    ```bash
     42    annepro2_tools annepro2_c15_default.bin
     43    ```
     44 
     45 If the tool can't find the keyboard please double check you have the keyboard in IAP mode.
     46 
     47 
     48 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).