From 7e3f04fe1c5c3bf6ab94ca98031c1d3efe734d9b Mon Sep 17 00:00:00 2001
From: Max Herzog <max.herzog@mailbox.tu-dresden.de>
Date: Tue, 30 Jul 2024 12:37:52 +0000
Subject: [PATCH] Clarified usage

---
 README.md | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 5452cb4..a043638 100644
--- a/README.md
+++ b/README.md
@@ -11,11 +11,14 @@ add https://gitlab.mn.tu-dresden.de/amem-group/tie
 in the built in package manager "Pkg", available from the julia REPL by typing "]".
 
 ## Usage
-An illustrative test example containing a (de)focused images of a Landau pattern can be carried out via
-```bash
-calculate_TIE("path_to_input_files_folder","Py_on_C.json")
+An illustrative example containing (de)focused images of a Landau pattern can be calculated using the data found in the example folder of the repository.
+To run the code, use
+```
+using TIE
+TIE.calculate_TIE("path_to_folder_with_input_files","name_of_json_file.json")
 ```
-that is in the test folder together with the numpy arrays of the (de)focused image intensities. The image intensity files and the json files should reside in the same path_to_input_files_folder. Output containing reconstructed phase and boundary function is also written into that folder.
+The output containing the reconstructed phase and boundary function is saved into the same folder.
+
 In the json file, the following metadata has to be supplied:
 
 - Uacc:     acceleration voltage of the electrons [V]
-- 
GitLab