From 8cb8fa0d6f5bdd75999ebae0a12695232c61a13a Mon Sep 17 00:00:00 2001 From: Michael Rabotin <michael.rabotin@inrae.fr> Date: Tue, 10 Aug 2021 15:14:19 +0200 Subject: [PATCH] modified readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index d96e50e..cbb7a0e 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,25 @@ What can I do with it? ====================== For the moment, the plugin's user interface is very basic. You can load a config file (just like you would do with classic hru-delin) and the plugin will run the 4 steps and load/display result files. You can select which steps you want to run, in case you just want to run a few steps or you already have intermediate results and you want to finish the job. + +How to install ? +================ +This plugins includes HRU delin v6.0 and imports it instead of executing it. +This repository has a submodule, this means hru-delin.git repository is nested into hru-delin-qgis.git. +Make sure you clone it like that: +git clone --recurse-submodules --remote-submodules git@gitlab-ssh.irstea.fr:hru-delin-dev/hru-delin-qgis.git +# or +git clone --recurse-submodules --remote-submodules https://gitlab.irstea.fr/hru-delin-dev/hru-delin-qgis.git + + +Produce a release +Edit version.txt and put the desired version number there. +There are 2 methods to produce a release .zip archive. + +Produce locally +You can run ./version.sh and it will produce a zip file ready to be distributed. + +Automated release +You can also push to build branch: +git push origin master:build +This will trigger a CI pipeline which will produce a release archive available in the pipeline list as an artifact. -- GitLab