From cdcec22e609688812bf0f5ac303cc9c6970efb23 Mon Sep 17 00:00:00 2001
From: ReFil <31960031+ReFil@users.noreply.github.com>
Date: Thu, 16 Nov 2023 07:49:39 +0000
Subject: Version compiled FW with automatic macro (#267)

* Version compiled FW with hash

Auto generates a macro to type out version info, local and github compilation now includes commit hash and timestamp in final uf2 files

* Fix local builds

makefile doesn't like the script returning the macro, directed to null for local builds as version.dtsi file accessible
---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index f876cf3..ac090a2 100644
--- a/README.md
+++ b/README.md
@@ -72,6 +72,10 @@ If you encounter a git conflict when updating your repository to V3.0 please fol
 
 Updating from V2.0 based firmwares to V3.0 based firmwares can be a rather complex process. There are reset files for every major firmware revision as well as documentation on the update process available [here](https://kinesis-ergo.com/support/kb360pro/#firmware-updates).
 
+## Versioning
+
+Starting on 11/15/2023 the Advantage 360 Pro will now automatically record the compilation date, branch and Git commit hash in a macro that can be accessed with Mod+V. This will type out the following string: YYYYMMDD-XXXX-YYYYYY, where XXXX is the first 4 characters of the Git branch and YYYYYY is the Git commit hash. In addition to this the builds compiled by GitHub actions are now timestamped and also record the commit hash in the filename. 
+
 ## Bluetooth LE Privacy
 
 Since the update on 20/10/2023, BLE privacy is now disabled by default and due to an update in upstream ZMK cannot be enabled again as it will cause issues for the split halves connecting to each other. 
-- 
cgit v1.2.3