arcane.git

arcane - keyboard firmware
==========================
arcane is a qmk keyboard firmware configuration for ergodox ez keyboards.
arcane features a split, reactive backlighting mode and uses a querty layout
with macros, special keys, and key positions specialised for c programming
using vim.

requirements
------------
arcane requires teensy_loader_cli, avr-gcc, and qmk_firmware.

installation
------------
arcane can be downloaded, built, and flashed with the following commands:

    git clone --recurse-submodules https://github.com/zsa/qmk_firmware/
    pacman -S teensy_loader_cli avr-gcc qmk

    # arch linux default installs it to a location different than qmk wants
    ln -sf /usr/bin/teensy_loader_cli /usr/bin/teensy-loader-cli

    cd qmk_firmware
    cp util/udev/50-qmk.rules /etc/udev/rules.d/

    # qmk activates -Werror then has code with warnings, so we need to fix it
    sed -i 's/-Werror//g' builddefs/common_rules.mk

    git clone https://git.arcnyxx.net/arcane
    mkdir -p keyboards/ergodox_ez/shine/keymaps/
    mv arcane keyboards/ergodox_ez/shine/keymaps/arcane
    make ergodox_ez/shine:arcane:flash

configuration
-------------
arcane can be configured by editing the keymap.c file and (re)compiling the
source code.