From 2326d93ae6ab2983f3b275f87437b2e7cfadba59 Mon Sep 17 00:00:00 2001
From: David Seus <david.seus@mathematik.uni-stuttgart.de>
Date: Fri, 9 Oct 2020 15:08:19 +0200
Subject: [PATCH] Update README.md
---
README.md | 22 +++++++++++++++++++---
1 file changed, 19 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 0f83f3a..76c653d 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,27 @@
# LDD simulation for two-phase flow systems (R–R, TP–TP, TP–R coupling)
-This project provides a Fenics based 2D domain decomposition code implementing an LDD solver for two-phase flow systems.
+This project provides a Fenics based 2D domain decomposition code implementing an LDD solver for two-phase flow systems that
+is part of the author's thesis.
Two-phase flow systems means, that each subdomain can either adopt the full two-phase flow equations or the Richards/Richardson equation.
Flexible domain substructurings are possible so long as each subdomain has polygonal boundary.
-## Setup and Installation
+## How to get started
To use this module, start by cloning the repository by running
git clone https://gitlab.mathematik.uni-stuttgart.de/seusdd/ldd-for-two-phase-flow-systems.git
-The folder [Setup](./Setup) instructions contains instructions on how to get `Fenics` up and running inside a docker container.
\ No newline at end of file
+The folder [Setup](./Setup) instructions contains instructions on how to get `Fenics` up and running inside a docker container.
+
+After following the steps decsribed in [Setup](./Setup), have a look at the folder [Usecases](./Usecases) where several usecases for this module can be found.
+Each of the usecases should be runnable out of the box and produce results. Adjust the files as needed.
+Most likely, you will want to create your own usecases featuring other data fuctions, substructurings and so on.
+Information on how to create your own usecases can be found in the folder [Usecases](./Usecases).
+
+## State
+### Curent starte
+Currently the code can
+
+## License
+`LDDsimulation` is licensed under the terms and conditions of the GNU General
+Public License (GPL) version 3 or - at your option - any later
+version. The GPL can be [read online](https://www.gnu.org/licenses/gpl-3.0.en.html) or in the [COPYING](./COPYING) file
+provided in the topmost directory of the `LDDsimulation` source code tree.
--
GitLab