keychron_qmk_firmware/keyboards/the_ruler/readme.md
noroadsleft 367eac2229 [Keyboard] PCB Ruler updates (#6584)
* Move default keymap's rules to keyboard level

* Concatenate the two sets of rules

This sets CONSOLE_ENABLE to no, which was being set at the keymap level.

* Wrap the USB Device Description in quotes

Some preventative maintenance. The firmware for the_ruler can't be compiled without this change if `CONSOLE_ENABLE = yes` because this string has a comma, which gets picked up as two arguments by the Command code, instead of one as it should be.

* Linting

- remove firmware size impacts
- remove trailing white space
- visual alignment of rules

* Use QMK's pre-loaded default rules for atmega32u4

* Update readme

- markdown formatting
- update Hardware Availability link (Maple Computing's site has disappeared)
- update Docs links

* Update header files to use #pragma once
2019-08-20 21:57:45 -07:00

14 lines
682 B
Markdown

# The Ruler PCB
A custom keyboard PCB ruler, that can also function as a macro pad.
Keyboard Maintainer: Maple Computing
Hardware Supported: PCB Ruler V1 by That-Canadian and Bishop Keyboards
Hardware Availability: [Bishop Keyboards](https://bishopkeyboards.com/product/pcb-ruler-gloss-black-silver/)
Make example for this keyboard (after setting up your build environment):
make the_ruler: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).