X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Fhardware_keyboard_guidelines.md;h=8b16a13c9b410b86e34639997943826ca7b11d65;hb=535c2f60a9336d67c1a3fbd2d335b6f24d8cca8d;hp=aedaa6301c69d6cfccf3444f4a737d73277adb8a;hpb=432674781a178857099e5035987e9ab96f846e19;p=qmk_firmware.git diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index aedaa6301..8b16a13c9 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md @@ -20,7 +20,7 @@ Any sort of hardware file (plate, case, pcb) can't be stored in qmk_firmware, bu As QMK grows so does the ecosystem surrounding QMK. To make it easier for projects in that ecosystem to tie into QMK as we make changes we are developing a metadata system to expose information about keyboards in QMK. -You can create `info.json` files at every level under `qmk_firmware/keyboards/<name>` to specify this metadata. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` specifies more specific information about Clueboard 66%. +You can create `info.json` files at every level under `qmk_firmware/keyboards/` to specify this metadata. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, `qmk_firmware/keyboards/clueboard/info.json` specifies `manufacturer` and `maintainer`, while `qmk_firmware/keyboards/clueboard/66/info.json` specifies more specific information about Clueboard 66%. ### `info.json` Format