From 85d0842e1fd20b8e2f6f6848d2f89edb1a475aad Mon Sep 17 00:00:00 2001 From: dl1com <1631996+dl1com@users.noreply.github.com> Date: Mon, 23 Sep 2024 22:14:09 +0200 Subject: [PATCH] Add info about branching concept (#202) * Add info about branching concept * fix typo --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0beb51f5..3e6aee5b 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,10 @@ http://ayab-knitting.com This is the firmware for the Arduino-based hardware that is part of the AYAB project. +## Branching Model + +**Development of the latest and upcoming features happens on the 'main' branch.** For each major release, a dedicated maintenance branch is created to manage bug fixes, security patches, and backporting for that specific release. These branches follow the naming convention -maint (e.g. *0.95-maint*). This approach allows us to continue forward development while ensuring stability and long-term support for previous versions. + ## Updating your AYAB firmware In [ayab-desktop](https://github.com/AllYarnsAreBeautiful/ayab-desktop): go to Tools \> Load AYAB Firmware.