7d60a141a2
* move RGB Matrix rules to keyboard level * move PERMISSIVE_HOLD config to keyboard level * annepro2.c: convert tabs to spaces * refactor rules.mk files Reformats each version's `rules.mk` file to be arranged more similarly to those of the rest of the keyboards in QMK. No logic change. * annepro2.c: allow compilation without RGB Matrix Wraps the `led_enabled` definition and the `KC_AP_RGB_*` keycodes in `#ifdef RGB_MATRIX_ENABLE`, allowing successful compilation if the user sets `RGB_MATRIX_ENABLE = no`. * rework readme files Reworks the main `readme.md` file to be more friendly to GitHub viewing, and removes the single-line version-specific readme files (exposes the main readme to QMK Configurator users). * info.json: update maintainer value * info.json: apply friendly formatting
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# Anne Pro 2 rev. C15 and C18 QMK firmware
|
|
|
|
An ANSI-layout 60% keyboard featuring Bluetooth support and per-key RGB lighting.
|
|
|
|
* Keyboard Maintainer: [bwisn](https://github.com/bwisn)
|
|
* Hardware Supported: Anne Pro 2, [C15](c15/) and [C18](c18/) versions
|
|
* Hardware Availability: [annepro.net](https://www.annepro.net/), [Hexcore](https://www.hexcore.xyz/annepro2)
|
|
|
|
## How to compile
|
|
|
|
After setting up your build environment, you can compile the Anne Pro 2 C18 default keymap by using:
|
|
|
|
make annepro2/c18:default
|
|
|
|
If you want to compile the Anne Pro 2 C15 default keymap use:
|
|
|
|
make annepro2/c15:default
|
|
|
|
## Installing
|
|
|
|
### Get AnnePro2 Tools
|
|
|
|
If you want the executable instead of compiling it yourself, [download it here](https://ci.codetector.org/job/OpenAnnePro/job/AnnePro2-Tools/job/master/).
|
|
Windows and Linux versions are available. Otherwise, follow the steps below:
|
|
|
|
1. Install the latest stable `rust` toolchain using [rustup](https://rustup.rs/)
|
|
1. Also install [Visual Studio Community edition](https://visualstudio.microsoft.com/downloads/)
|
|
including the C/C++ module to prevent errors while compiling
|
|
1. Download or Clone the [AnnePro2-Tools](https://github.com/OpenAnnePro/AnnePro2-Tools) project.
|
|
1. Compile the tool using
|
|
```bash
|
|
cargo build --release
|
|
```
|
|
The compiled tool should be in `./target/release/annepro2_tools` (In later I will refer to this as `annepro2_tools`)
|
|
|
|
### Flashing the firmware
|
|
|
|
1. Put the keyboard into DFU/IAP mode by unplugging the keyboard, then holding ESC while plugging it back in.
|
|
1. Run annepro2_tools with the firmware you just built.
|
|
**Please substitute with the correct paths and correct bin file if you chose another keymap profile.**
|
|
```bash
|
|
annepro2_tools annepro2_c15_default.bin
|
|
```
|
|
|
|
If the tool can't find the keyboard please double check you have the keyboard in IAP mode.
|
|
|
|
|
|
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).
|