aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorroot <andy@andydoestech.com>2018-06-15 20:27:32 +0000
committerroot <andy@andydoestech.com>2018-06-15 20:27:32 +0000
commita0ab15dd080b22e7440fdd5ff200239db6d0e1d0 (patch)
tree2fa82cd7fac66718ac06077b277f81ee454d4253
parentaf4f5f4c175ed0af8ee69eb3073662f84ecb8c02 (diff)
updated readme
-rw-r--r--Makefile.pre5
-rw-r--r--README.md15
2 files changed, 18 insertions, 2 deletions
diff --git a/Makefile.pre b/Makefile.pre
index 2db2875..a90aa8e 100644
--- a/Makefile.pre
+++ b/Makefile.pre
@@ -12,6 +12,11 @@ install:
cp build/cgitrc/ /etc
mkdir -p /usr/local/bin
cp build/filters/* /usr/local/bin
+ @echo ""
+ @echo "######################################################"
+ @echo "# Add the following line to Apache VirtualHost"
+ @echo "# Use CgitPage /$$(basename "$(call getsetting,tmp/settings.txt,CGITURL)")"
+ @echo "######################################################"
build/cgitrc: build
m4 -DCGITCSS="$(call getsetting,tmp/settings.txt,CGITCSS)" -DGITPATH="$(call getsetting,tmp/settings.txt,GITPATH)" cgitrc.m4 > build/cgitrc
diff --git a/README.md b/README.md
index f7d24d4..e07a541 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
-# cgit-portal
-Provides a files necessary for creating a user-friendly portal for cgit and apache.
+# cgit-portal
+This provides a PHP-based portal page for cgit, the Apache config, cgit config, and about-filters for cgit.
+
+Works with Debian and CentOS
+
+# Requires:
+* pandoc
+* apache
+* cgit
+
+# Build/Install
+1. Run ```make```
+2. Run ```sudo make install```