From 1662ff1e247af0ac1e18e2609b1afa9d252fe017 Mon Sep 17 00:00:00 2001
From: Pierre-Antoine Rouby <pierre-antoine.rouby@inrae.fr>
Date: Tue, 12 Sep 2023 11:00:01 +0200
Subject: [PATCH] git: Update the README with sections 'features' and
 'install'.

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index aae49142..83b88d5d 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,50 @@
-# PamHyr (Programme d’Aide à la Modélisation en Hydraulique des Rivières)
+# Pamhyr2
+
+Pamhyr is a free and open source graphical user interface for 1D hydro-sedimentary
+modelling of rivers.
+
+## Features
+
++ Edit a complex river hydraulics network
++ Define the river geometry
++ Define boundary conditions
++ Define lateral contribution
++ Edit river friction
++ Generate initial conditions
++ Edit river sedimentary layers
++ Save the study in a unique file
++ Run Mage 8 on a study and visualize results
+
+## Install
+
+### GNU/Linux
+
+Downloads [last
+realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
+GNU/Linux binary archive.
+
+```shell
+tar xf pamhyr-gnulinux-amd64.tar.xz
+cd pamhyr
+./pamhyr
+```
+
+### Windows
+
+Downloads [last
+realease](https://gitlab.irstea.fr/theophile.terraz/pamhyr/-/releases/permalink/latest)
+Windows installer.
+
+### From source code
+
+```shell
+# Get source code
+git clone https://gitlab.irstea.fr/theophile.terraz/pamhyr/
+cd pamhyr
+
+# Install dependencies
+pip3 install -r requirements.txt
+
+# Run pamhyr
+./src/pamhyr.py
+```
-- 
GitLab