commit cadbc6804d6e8dce3d341a6646a0492e06cfed24
parent 1a8ccd41de4881504c2359da1117ac6e0286c60c
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 27 Apr 2024 17:44:52 +0200
Use plaintext readme
Diffstat:
| A | README | | | 46 | ++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README.md | | | 36 | ------------------------------------ |
2 files changed, 46 insertions(+), 36 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,46 @@
+Stagit - src.jayvii.de
+======================
+
+Please send patches or remarks to <jayvii[AT]posteo[DOT]de>
+
+Some scripts and assets to run https://src.jayvii.de
+
+Structure
+---------
+
+|- bin/
+| |- git_create_repo.sh Creates A bare repository and HTML viewer
+| |- git_post_push.sh Used as post-push hook in repositories
+| |- git_set_clone_url.sh Sets necessary URL to clone via http(s)
+| |- git_update_index_html.sh Updates the repository overview HTML page
+| |- git_update_repo_html.sh Updates the respository HTML viewer pages
+| '- git_update_repo.sh Updates git information to clone via http(s)
+|
+|- assets/
+| |- favicon.png Favicon and Logo of the page
+| |- index.css CSS for the index pages (e.g. the *.git pages)
+| '- style.css CSS for the HTML viewer
+|
+|- 404.html 404 Page
+'- index.html Index-Page for the Main site, redirects to /pub/
+
+There are additional links for CSS and icon files.
+
+Setup
+=====
+
+- Install https://www.codemadness.org/git/stagit/ on your Server
+- Use this template:
+ git clone https://src.jayvii.de/pub/stagit-jayvii.de.git /var/www/git.myserver.com
+- Setup the HTML Root:
+ mkdir -p /var/www/git.myserver.com/{pub,priv}
+- Setup git-user:
+ useradd -r -m -U -d /var/www/git.myserver.com -s /bin/sh git
+
+Optional Tweaks
+---------------
+
+You may also setup SSH-credentials for the user or SSH-Auth keys.
+
+You most likely want to setup a webserver (e.g. Apache2) with "/var/www/
+git.myserver.com" (home of user "git") as its root-dir.
diff --git a/README.md b/README.md
@@ -1,36 +0,0 @@
-# Stagit - src.jayvii.de
-
-Some scripts and assets to run https://src.jayvii.de
-
-```
-/
-|- bin/
-| |- git_create_repo.sh Creates A bare repository and HTML viewer
-| |- git_post_push.sh Used as post-push hook in repositories
-| |- git_set_clone_url.sh Sets necessary URL to clone via http(s)
-| |- git_update_index_html.sh Updates the repository overview HTML page
-| |- git_update_repo_html.sh Updates the respository HTML viewer pages
-| '- git_update_repo.sh Updates git information to clone via http(s)
-|
-|- assets/
-| |- favicon.png Favicon and Logo of the page
-| |- index.css CSS for the index pages (e.g. the *.git pages)
-| '- style.css CSS for the HTML viewer
-|
-|- 404.html 404 Page
-'- index.html Index-Page for the Main site, redirects to /pub/
-```
-
-There are additional links for CSS and icon files.
-
-## Setup
-
-- Install [Stagit](https://www.codemadness.org/git/stagit/) on your Server
-- Use this template: `git clone https://src.jayvii.de/pub/stagit-jayvii.de.git /var/www/git.myserver.com`
-- Setup the HTML Root: `mkdir -p /var/www/git.myserver.com/{pub,priv}`
-- Setup git-user: `useradd -r -m -U -d /var/www/git.myserver.com -s /bin/bash git`
-
-Optional:
-
-You may also setup SSH-credentials for the user or SSH-Auth keys.
-You most likely want to setup a webserver (e.g. Apache2) with `/var/www/git.myserver.com` as its root-dir.
