From 0a5596fe63a856b36be0e0bd608f298913324ef9 Mon Sep 17 00:00:00 2001
From: "Edgar P. Burkhart" <git@edgarpierre.fr>
Date: Tue, 29 Mar 2022 13:07:12 +0200
Subject: [PATCH] Updated README with help on running modules

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 38c524d..e299b6c 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,21 @@ displacement at the Artha breakwater on February 28, 2017"
 
 [Report](https://kalliope.edgarpierre.fr/latex/m2cce/internship/report.pdf)
 
+## Configuration
+
+Each part can be run in their respective directories.
+```
+$  python -m processing.swash -h
+usage: swash.py [-h] [-v] [-c CONFIG]
+
+Run swash model
+
+options:
+  -h, --help            show this help message and exit
+  -v, --verbose
+  -c CONFIG, --config CONFIG
+```
+
 ## Bathymetry
 
 * Insert database in `data/data`