qmk-firmware/keyboards/alu84/readme.md
James Young c0149dc376
Alu84 Refactor (#13760)
* info.json: human-friendly formatting

* use QMK 3-character notation for layout macro/data

* alu84.h: use #pragma once include guard

* clean up alu84.c

Remove unnecessary includes and functions.

* refactor config.h

- use #pragma once include guard
- enable Backlight Breathing
- align comments to QMK AVR template

* refactor default keymap

- add license header
- use layer_names enum
- refactor keymap to be more generic
- remove unnecessary and empty functions

* refactor turbomech keymap.c

- edit license header
- refactor keymap for readability (use QMK-native keycode aliases)
- remove unnecessary and empty functions

* refactor turbomech config.h

- use #pragma once include guard
- align to QMK template

* refactor turbomech rules.mk

Edit the file to make it conform to QMK template.

* align rules.mk to QMK template

* touch-up default keymap

* touch-up alu84.h

* rename LAYOUT to LAYOUT_75_ansi

Also enables Community Layout Support

* modernize readme.md

- update description
- convert keyboard data to list
- add flashing and bootloader instructions
- update Docs links

* alias LAYOUT to LAYOUT_75_ansi

* change readme image URL per fauxpark

* touch up turbomech keymap rules.mk per fauxpark

* rules.mk: convert tab to spaces
2021-07-29 11:09:16 -07:00

22 lines
796 B
Markdown

# ALU84
![alu84](https://i.imgur.com/wBfazDch.jpg)
A 75% keyboard made and sold by MECHKEYS.
* Keyboard Maintainer: [The QMK Community](https://github.com/qmk)
* Hardware Supported: ALU84
* Hardware Availability: [~~MECHKEYS~~](https://mechkeys.ca) (No longer available)
Make example for this keyboard (after setting up your build environment):
make alu84:default
Flashing example for this keyboard:
make alu84:default:flash
To reset the board into bootloader mode, hold Space+B while plugging the cable in.
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).