From bfa906121e9b088442707601245d2589e3ed9315 Mon Sep 17 00:00:00 2001
From: JozanLeClerc <bousset.rudy@gmail.com>
Date: Wed, 8 Jul 2020 16:54:11 +0200
Subject: README update

---
 README.org | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 8e7ebbb..fa97505 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,35 @@
 #+TITLE: My server scripts
 
-These are a bunch of scripts for my VPS server.
+These are a bunch of scripts for my VPS server. They might only run on BSD servers.
+
+* Dependecies
+- *BSD*-type operating system
+- ~perl~
+- ~dash~ shell
+- ~git~
+- ~stagit~
+
+* Functions
+The source tree is the following:
+
+#+BEGIN_SRC shell
+└── src
+    ├── distant
+    ├── gitjoe
+    │   ├── addsshkey.pl
+    │   ├── chdesc.pl
+    │   ├── chowner.pl
+    │   ├── newrepo.pl
+    │   ├── newuser.pl
+    │   ├── rmrepo.pl
+    │   └── rmuser.pl
+    ├── other
+    │   └── git-ro-daemon.pl
+    └── update
+        ├── gitjoe.pl
+        └── serv.pl
+#+END_SRC
+
+- ~gitjoe/~ scripts are meant to be run on the server directly. They are tools to add GitJoe users, repos,
+change descritpion, etc.
+- ~update/~ scripts are run via cron jobs. They update the GitJoe repositories front-end website via ~stagit~ and pull ~master~ branches of the websites via ~git~
-- 
cgit v1.2.3