From 643223d169f1d9b53e9080ed78b13868a18d7973 Mon Sep 17 00:00:00 2001
From: Shipwreckt <me@shipwreckt.co.uk>
Date: Sat, 22 Feb 2025 20:35:48 +0000
Subject: Dumbed things down in README and added some themes

---
 README | 79 +++++++++++++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 57 insertions(+), 22 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 9383f3d..c93ecdf 100644
--- a/README
+++ b/README
@@ -1,43 +1,64 @@
-stagit
-------
 
-static git page generator.
+Intro
+-----
 
-It generates static HTML pages for a git repository.
+Note: I am not the original creator; that would be codemadness. I have forked his repository to make it simpler and easier to understand for users like myself. In simple works a dummies version of staggit! If you have any suggestions or questions, please email me at me@shipwreckt.co.uk.
 
+Original creator's website:
+https://codemadness.org/stagit.html 
 
-Usage
+There are themes for Staggit in the themes directory. I have taken them from various websites. If you recognize your theme and are unhappy with its inclusion, please contact me.
+If you want to try out a theme just copy it to your style.css.
+
+Websites that I love the feel of !
+https://git.shipwreckt.co.uk
+https://git.pyratebeard.net
+https://git.drkhsh.at
+
+About
 -----
+stagit is a static page generator for your git server. It generates static HTML pages from a selection of git repos.
 
-Make files per repository:
+The creator is codemadness, highly suggest looking at his website it is a good read.
+https://codemadness.org
 
-	$ mkdir -p htmlroot/htmlrepo1 && cd htmlroot/htmlrepo1
-	$ stagit path/to/gitrepo1
-	repeat for other repositories
-	$ ...
 
-Make index file for repositories:
+Dependencies
+------------
 
-	$ cd htmlroot
-	$ stagit-index path/to/gitrepo1 \
-	               path/to/gitrepo2 \
-	               path/to/gitrepo3 > index.html
+- C compiler (C99).
+- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
+- libgit2 (v0.22+).
+- POSIX make (optional).
 
 
 Build and install
 -----------------
-
+cd stagit
 $ make
 # make install
 
 
-Dependencies
-------------
 
-- C compiler (C99).
-- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
-- libgit2 (v0.22+).
-- POSIX make (optional).
+Usage
+-----
+I am going to assume that your git server is located in /srv/git like the official website directs. If in a diffrent directory change the command to fit where your git repos are located.
+I am also going to assume that you are using nginx. I do not use apache so I am unsure if websites are located in /var/www/ so if they are not change the command to fit where you want your website located please.
+
+
+Make files per repo:
+  
+  $ mkdir -p /var/www/git/htmldir/<name of your repo> && cd /var/www/git/htmldir/<name of your repo>
+  $ stagit /srv/git/<name of your repo>.git
+	repeat for other repositories
+
+
+Make index.html file for all of your repositories:
+
+	$ cd htmlroot
+	$ stagit-index path/to/gitrepo1 \
+	               path/to/gitrepo2 \
+	               path/to/gitrepo3 > index.html
 
 
 Documentation
@@ -46,6 +67,20 @@ Documentation
 See man pages: stagit(1) and stagit-index(1).
 
 
+Set owner of a repo
+-------------------
+
+cd /srv/git/<name of your repo>.git
+echo YourName > owner
+
+
+Set URL link of a repo
+----------------------
+
+cd /srv/git/<name of your repo>.git
+echo git://<your domain or ip>/<name of your repo without .git> > url
+
+
 Building a static binary
 ------------------------
 
-- 
cgit v1.2.3