From 6c5257ff3e510a15d1c4262787b292fe55beab77 Mon Sep 17 00:00:00 2001 From: Tim Crawford Date: Thu, 3 Jun 2021 16:10:55 -0600 Subject: [PATCH] readme: Add note about releases Explain why there are no tagged releases, and why the commit hash on official releases does not match commits from this repo. Signed-off-by: Tim Crawford --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 846c73e..39a8c69 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,18 @@ file to update `PATH`. ``` source $HOME/.cargo/env ``` + +## Releases + +The EC firmware itself does not have tagged releases. Any commit of this repo +may be used as a part of a [System76 Open Firmware][firmware-open] release. + +In official releases the EC shares the same version as the BIOS firmware. Run +the follow command from firmware-open to determine the corresponding EC commit +for a release. + +``` +git ls-tree ec +``` + +[firmware-open]: https://github.com/system76/firmware-open