From d8a8a497579eeb8d26212825249dcc58eb49ee90 Mon Sep 17 00:00:00 2001 From: zvecr Date: Sun, 26 May 2024 21:44:44 +0100 Subject: [PATCH] Mention keyboard.json --- docs/ChangeLog/20240526.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/ChangeLog/20240526.md b/docs/ChangeLog/20240526.md index 07ffb2d42e..c1e805729b 100644 --- a/docs/ChangeLog/20240526.md +++ b/docs/ChangeLog/20240526.md @@ -2,6 +2,11 @@ ## Notable Features :id=notable-features +_0.25.0_ is mainly a maintenance release of QMK Firmware -- as per last few breaking changes cycles, there have been a lot of behind-the-scenes changes, mainly: + +* continued migration of configuration into `.json` files +* addressing technical debt + ## Changes Requiring User Action :id=changes-requiring-user-action ### Updated Keyboard Codebases :id=updated-keyboard-codebases @@ -34,6 +39,21 @@ One note with updated keyboard names -- historical keyboard names are still cons ## Notable core changes :id=notable-core +### Introduction of `keyboard.json` ([22891](https://github.com/qmk/qmk_firmware/pull/22891)) :id=keyboard-json + +One longer term goal of QMK is increased maintainability. + +As part of the continued push towards [Data Driven Configuration](data_driven_config.md), the build system has been updated to simplify the existing codebase, and power future workflows. + +The `keyboard.json` configuration file allows the support of a single data file for keyboard level config. + +Additionally, +* `info.json` now represents potential fragments of config that can be shared across keyboard revisions. +* `rules.mk` is now optional - Completely blank files are no longer required. +* Currently supported keyboards have been migrated to reflect this change. + +Backwards compatibility of the old system has been maintained, but will be removed in a future breaking changes cycle. + ## Full changelist :id=full-changelist Core: