diff options
| author | James Young <18669334+noroadsleft@users.noreply.github.com> | 2021-07-29 11:09:16 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-29 11:09:16 -0700 |
| commit | c0149dc37601e897e57739c65bbd8a4890adb4f7 (patch) | |
| tree | 20632a07a62af2752fdd51392fe794fe24ee5faa /keyboards/alu84/readme.md | |
| parent | a78fdbb1f63305c4960642dc1005d06d5d0e69be (diff) | |
| download | qmk_firmware-c0149dc37601e897e57739c65bbd8a4890adb4f7.tar.gz qmk_firmware-c0149dc37601e897e57739c65bbd8a4890adb4f7.zip | |
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
Diffstat (limited to 'keyboards/alu84/readme.md')
| -rw-r--r-- | keyboards/alu84/readme.md | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/keyboards/alu84/readme.md b/keyboards/alu84/readme.md index f98addd0b..12da1d8a8 100644 --- a/keyboards/alu84/readme.md +++ b/keyboards/alu84/readme.md | |||
| @@ -1,16 +1,21 @@ | |||
| 1 | ALU84 | 1 | # ALU84 |
| 2 | === | ||
| 3 | 2 | ||
| 4 |  | 3 |  |
| 5 | 4 | ||
| 6 | A 75% keyboard made and sold by MECHKEYS [More info on MECHKEYS](https://mechkeys.ca). | 5 | A 75% keyboard made and sold by MECHKEYS. |
| 7 | 6 | ||
| 8 | Keyboard Maintainer: [TurboMech](https://github.com/TurboMech) | 7 | * Keyboard Maintainer: [The QMK Community](https://github.com/qmk) |
| 9 | Hardware Supported: ALU84 | 8 | * Hardware Supported: ALU84 |
| 10 | Hardware Availability: [MECHKEYS](https://mechkeys.ca) | 9 | * Hardware Availability: [~~MECHKEYS~~](https://mechkeys.ca) (No longer available) |
| 11 | 10 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 13 | 12 | ||
| 14 | make alu84:default | 13 | make alu84:default |
| 15 | 14 | ||
| 16 | See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. | 15 | Flashing example for this keyboard: |
| 16 | |||
| 17 | make alu84:default:flash | ||
| 18 | |||
| 19 | To reset the board into bootloader mode, hold Space+B while plugging the cable in. | ||
| 20 | |||
| 21 | 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). | ||
