From aaec735faf81ff05356d65c7408136d2c1522d34 Mon Sep 17 00:00:00 2001 From: Travis Staton Date: Mon, 18 Nov 2024 09:56:57 -0500 Subject: [PATCH] add stability note --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4c7882e..8c94ef9 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,12 @@ The important modules are `overlay/default.nix`, `rpi/default.nix`, and `rpi/config.nix`. The other modules are mostly wrappers that set `config.txt` settings and enable required kernel modules. +## Stability note + +`master` is the development branch -- if you want to avoid breaking changes, you +should pin your flake to a specific release and refer to the release notes when +upgrading. + ## Example See the `rpi-example` config in this flake for an example config built by CI.