# HG changeset patch
# User Edouard Tisserant <edouard.tisserant@gmail.com>
# Date 1661102939 -7200
# Node ID 072fcebf8bf00854c03cdaa20fe835e77ff0512e
# Parent  86aab112a8f45ce3a607f59dde8ac542e08efeec
Update documentation.

diff -r 86aab112a8f4 -r 072fcebf8bf0 README.md
--- a/README.md	Sun Aug 21 19:28:43 2022 +0200
+++ b/README.md	Sun Aug 21 19:28:59 2022 +0200
@@ -1,12 +1,32 @@
 # Beremiz public distribution #
 
-This repository holds recipes and patches to build the Beremiz related 
-bundles, packages, installers and images available on 
-[Beremiz website](http://www.beremiz.org/).
+This repository holds recipes and patches to build the Beremiz 
+packages and installers for [Beremiz website](http://beremiz.org/).
 
-Patches have same license as projects beeing patched. For other files,
+Patches have same license as projects being patched. For other files,
 unless made explicit in file header, GPLv3 applies.
 
+## Use cases ##
+
+Beremiz development uses Mercurial, but git repositories that are kept in sync.
+
+Build from both Mercurial and Git repositories is supported.
+
+### GitHub CI ##
+
+Use code from https://github.com/beremiz repositories.
+
+Workflows described in .github/workflows are meant to run on a GitHub runner. Please refer to GitHub documentation to run workflows on your own fork.
+
+Dockerfile and part of Makefiles are used for windows installer build, but for Snap build, only snapcraft.yaml is used.
+
+### Manual build ###
+
+Use code from your local Mercurial repositories, cloned from https://hg.beremiz.org
+
+Uses Makefiles and Dockerfile to build windows installer and Makefile+snapcraft.yaml for Snap package.
+
+Hereafter is documented how to use Makefile and Docker in case of Manual Build
 
 ## Prerequisites ##
 
@@ -29,10 +49,10 @@
      /beremiz_public_dist
      /canfestival
      /matiec
+     /Modbus
 ```
 
-If any of Beremiz, Matiec or CanFestival repositories are missing, they will be
-cloned aside beremiz_public_dist from https://hg.beremiz.org .
+Repositories can be cloned from https://hg.beremiz.org .
 
 Intermediate and final results are all placed in a single 'build directory'
 during build process.