From 51594b5ee495628404f2f6040066627bff7fce61 Mon Sep 17 00:00:00 2001
From: Trevor Batley <trevorb@noreply.koozali.org>
Date: Wed, 10 May 2023 02:49:40 +0200
Subject: [PATCH] added details about each file

---
 README.md | 31 ++++++++++++++++++++-----------
 1 file changed, 20 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 6135b7b..dec4d83 100644
--- a/README.md
+++ b/README.md
@@ -4,18 +4,27 @@ Utilities to use with smeserver on Koozali.org GITEA instance
 
 Just a repackaging of Brian Read's tools with some modifications for the new git structure and some tidy-up of the ini file and debug statements
 
-# config
-sample ~/.smegit/config or /etc/smegit.ini file - fill in your details
-<br />It will use the user config first and system ini if user config does not exist
+* config\
+sample ~/.smegit/config or /etc/smegit.ini file - fill in your details\
+It will use the user config first and system ini, if user config does not exist
 
-# git-cvs2git.sh
-copy current cvs version of a package across to git in new structure
+* git-cvs2git.sh\
+copy current cvs version of a package across to git in new structure\
+git-cvs2git.sh \<repository\> \<organisation\> \[\<local\>\]\
+\<organisation\> can ONLY be smeserver or smecontribs\
+\<local\> will migrate into your local GITEA (in config), otherwise remote GITEA
 
-# git-get-and-build-repo.sh
-bring down current git repository and run mockbuild
+* git-get-and-build-repo.sh\
+bring down current git repository and run mockbuild\
+git-get-and-build.sh \<repository\> \<organisation\> \[\<local\>\]\
+\<local\> will build from local GITEA (in config) otherwise from remote GITEA
 
-# git-mirror-rep.sh
-create mirror of src.koozali.org repository in a local GITEA instance
+* git-mirror-repo.sh\
+create mirror of src.koozali.org repository in a local GITEA instance\
+git-mirror-repo.sh \<repository\> \<organisation\> \[\<target organisation\>\]\
+\<target organisation\> within your local GITEA, otherwise local user
 
-# git-mirror-org.sh
-create mirrors of all repos for an organisation in a local GITEA instance
+* git-mirror-org.sh\
+create mirrors of all repos for an organisation in a local GITEA instance\
+git-mirror-org.sh \<organisation\> \[\<target organisation\>\]\
+\<target organisation\> within your local GITEA, otherwise local user
\ No newline at end of file