From e1ececff95315e38c685f687fa50d72461442fa4 Mon Sep 17 00:00:00 2001
From: Hans LM <duerrhans@web.de>
Date: Thu, 1 Feb 2024 21:46:37 +0100
Subject: [PATCH] improvements in doc

---
 README.md | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index edb09d7..d57c770 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,11 @@
-Assumed directory structure
+The shell script `movelatexoutput.sh` makes sure that the output of a LaTeX 2 PDF process is stored in a separate folder and both folder and generated PDF change their names according to the name of the git branch.
+This requires a git administered bunch of .tex files 
+
+
+### Assumed directory structure
 ```
 .
+├── .git
 ├── <outputfolder>
 │   ├── <branchname1>
 │   │   └── <branchname1>.pdf
@@ -19,9 +24,16 @@ Assumed directory structure
 └── movelatexoutput.sh
 ```
 
+### LaTeX scenario:
+- Each document is based on the same latex template ('sample.tex'), which includes a ''content.tex'' file.
+- The content file is changing for each document.
+- Each document and thus each content file is stored in a separate GIT branch.
+
+The git repository lies within the main directory.
+
+**The shell script copies the generated PDF to a subdirectory named according to the name of the GIT branch and also renames the PDF file to the branch name.**
 
-Each document is based on the same latex template ('sample.tex'), which includes a ''content.tex'' file.
-The content file is changing for each document.
-Each document and thus each content file is stored in a separate GIT branch.
+### Usage:
+`$ ./movelatexoutput <outputfolder>`
 
-The shell script copies the generated PDF to a subdirectory named according to the name of the GIT branch and also renames the PDF file to the branch name.
+The name of the output directory "<outputfolder>" parameter is mandatory.