From b8975e6aa8c0734a779234610c1aa906d183365e Mon Sep 17 00:00:00 2001
From: Leonard Kugis <leonard@kug.is>
Date: Wed, 17 Sep 2025 18:50:48 +0200
Subject: Added README

---
 README.md  | 38 ++++++++++++++++++++++++++++++++++++++
 README.url |  1 -
 2 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 delete mode 100644 README.url

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4d113f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# cgithub
+
+A GitHub-like theme for cgit.
+
+Fork of: [https://www.hackitu.de/cgithub/](https://www.hackitu.de/cgithub/)
+
+## Installation
+
+### Build from source
+
+1. `cd` into source directory where `Dockerfile` resides.
+2. Run `docker buildx build --pull -t cgithub:latest .` to build the image and tag it as `cgithub:latest`.
+3. Run the image as container:
+```bash
+docker run --rm \
+    --read-only -v /media/mnt/vcs/git:/mnt:ro --tmpfs /tmp:size=10%,mode=1777,rw,noatime,noexec,nosuid,nodev \
+    --user $(id -u www-data):$(getent group git | cut -d: -f3) --security-opt=no-new-privileges:true --cap-drop=all \
+    --network=host -e APACHE_PORT=8080 --name cgit cgithub:latest
+```
+
+### Run as docker compose
+
+1. `cd` into directory where `docker-compose.yml` resides.
+2. Adjust `docker-compose.yml` to your liking.
+3. Run `docker compose up -d` to run the container.
+
+### Run directly
+
+```bash
+docker run --rm \
+    --read-only -v /media/mnt/vcs/git:/mnt:ro --tmpfs /tmp:size=10%,mode=1777,rw,noatime,noexec,nosuid,nodev \
+    --user $(id -u www-data):$(getent group git | cut -d: -f3) --security-opt=no-new-privileges:true --cap-drop=all \
+    --network=host -e APACHE_PORT=8080 --name cgit lionheart1810/cgithub:latest
+```
+
+## References
+
+- [Original guide](https://www.hackitu.de/cgithub/)
diff --git a/README.url b/README.url
deleted file mode 100644
index 982bec3..0000000
--- a/README.url
+++ /dev/null
@@ -1 +0,0 @@
-http://www.hackitu.de/cgithub/
-- 
cgit v1.2.3