Skip to content

Commit

Permalink
README.md: add branches info
Browse files Browse the repository at this point in the history
  • Loading branch information
zinccyy committed Mar 21, 2023
1 parent 62c14a6 commit a49246f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ The following software is additionally required on the target system:
* systemd
* ntpd

### Branches
The project uses 2 main branches `main` and `devel`. Other branches should not be cloned. In `main` there are files of the last official release. Any latest improvements and changes, which were tested at least briefly are found in `devel`. On every new release, `devel` is merged into `main`.

This means that when only stable official releases are to be used, either `main` can be used or specific releases downloaded. If all the latest bugfixes should be applied, `devel` branch is the one to be used. Note that whenever a new issue is created and it occurs on the `main` branch, the first response will likely be to use `devel` before any further provided support. Also, when creating a **Pull Request**, the target branch should always be set to `devel`.

### Build

First clone the repository:
Expand Down

0 comments on commit a49246f

Please sign in to comment.