From 2c9a7c6395772b027fbb15f1a485a843eda43f38 Mon Sep 17 00:00:00 2001 From: Michal Vasko Date: Fri, 13 Dec 2019 15:33:29 +0100 Subject: [PATCH] doc UPDATE information about branches --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d3d692e57..3d6ca7023 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,16 @@ Monitoring and Configuration](https://www.liberouter.org/) department of [CESNET](http://www.ces.net/). Any feedback, testing or feature requests are welcome. Please contact us via the [issue tracker](https://github.com/CESNET/Netopeer2/issues). +## Branches + +The project uses 2 main branches `master` and `devel-server`. Other branches should not be cloned. In `master` there are files of the +last official *release*. Any latest improvements and changes (of the server), which were tested at least briefly are found +in `devel-server`. On every new *release*, `devel-server` is merged into `master`. + +This means that when only stable official releases are to be used, either `master` can be used or specific *releases* downloaded. +If all the latest bugfixes should be applied, `devel-server` branch is the one to be used. Note that whenever **a new issue is created** +and it occurs on the `master` branch, the **first response will likely be** to use `devel-server` before any further provided support. + ## Components - **CLI** - simple command line interface to connect to a NETCONF server (device). - **server** - NETCONF server with a modular datastore allowing interconnection and control of