diff options
author | Logan Foster <[email protected]> | 2024-02-21 14:35:39 -0800 |
---|---|---|
committer | GitHub <[email protected]> | 2024-02-21 15:35:39 -0700 |
commit | 4e04da397ef643f8fcf4afbe1d19f63aee1fc561 (patch) | |
tree | 98707a6f1334b17d706c6b613bac8c352b16610a /keyboards/compensator/readme.md | |
parent | 7df44ffb751369d7632d6bb6affb8119ce3d038b (diff) | |
download | qmk_firmware-4e04da397ef643f8fcf4afbe1d19f63aee1fc561.tar.gz qmk_firmware-4e04da397ef643f8fcf4afbe1d19f63aee1fc561.zip |
[Keyboard] Add the Compensator (#23103)
* Pushed up compensator start
* Addressed Firmware Changes
* Fixed some keybind issues
* Updated readMe
* Added keymap
* Adjustments for PR
* adjusted on-state
* Applied sugguested changes
* Addressed PR changes
* Addressed macro comments
* Addressed layer comments
Diffstat (limited to 'keyboards/compensator/readme.md')
-rw-r--r-- | keyboards/compensator/readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/compensator/readme.md b/keyboards/compensator/readme.md new file mode 100644 index 0000000000..13502ecad2 --- /dev/null +++ b/keyboards/compensator/readme.md @@ -0,0 +1,24 @@ +# The Compensator + +[Compensator](https://i.imgur.com/fAB2SSTh.png) + +A 40% monstrosity with 10U spacebar support and a required 2 keycap sets to fill. It supports VIA. [Geekhack Post](https://geekhack.org/index.php?topic=122493.0) + +* Keyboard Maintainer: [Lrfoster03](https://lrfoster03.github.io/) and on [GitHub](https://github.com/Lrfoster03) +* Hardware Supported: A 40% with 2 numpads, 2 nav clusters, and 2 XT columns with an ATMEGU32U4 +* Hardware Availability: Contact @victusss on discord. [vk.works Discord](https://discord.gg/7weV2kyqFB) + +## Instructions + +### Build + +Make example for this keyboard (after setting up your build environment): + + make compensator:default + +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). + +### Flash +- Ensure PCB is plugged in and recognized by the computer +- Hold Physical reset button on back of the PCB to enter bootloader mode +- Flash using QMK Toolbox or CLI (`make compensator:<keymap>:flash`) |