From d52262c4d4b272edf81a19aceba6db029cdad85e Mon Sep 17 00:00:00 2001
From: Daniel Vedder <daniel.vedder@idiv.de>
Date: Fri, 25 Nov 2022 13:34:44 +0100
Subject: [PATCH] Updated README.md to explain config file workflow

---
 README.md | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 5d67c81..8772a49 100644
--- a/README.md
+++ b/README.md
@@ -30,8 +30,12 @@ This is the normal mode of operation. Simply execute `run.sh`, typically like so
 > ./run.sh -c <config>
 ```
 
-where `<config>` specifies the configuration file to use. The full list of commandline
-arguments is:
+where `<config>` specifies the configuration file to use. The recommended workflow is
+to copy `scr/parameters.toml` to a location of your choice and edit the copy to suit
+your requirements. The adapted config file can then be passed to `run.sh`. (If no
+configuration file is specified, Persephone will run with its default settings.)
+
+The full list of commandline arguments is:
 
 ```
 usage: run.jl [-c CONFIGFILE] [-s SEED] [-m MAPFILE] [-o OUTDIR]
@@ -65,7 +69,8 @@ Pkg.activate(".") # assuming you're in the Persephone root folder
 using Persephone
 ```
 
-You can then access all Persephone functions, such as `simulate()`.
+You can then access all Persephone functions, such as `simulate()`. (See
+`src/Persephone.jl` for a list of exported functions.)
 
 ---
 
-- 
GitLab