summaryrefslogtreecommitdiff
path: root/example.sh
diff options
context:
space:
mode:
Diffstat (limited to 'example.sh')
-rw-r--r--example.sh5
1 files changed, 4 insertions, 1 deletions
diff --git a/example.sh b/example.sh
index 84ccffd..57290d3 100644
--- a/example.sh
+++ b/example.sh
@@ -2,11 +2,14 @@
# - Makes index for repositories in a single directory.
# - Makes static pages for each repository directory.
#
-# NOTE, things to do manually (once):
+# NOTE, things to do manually (once) before running this script:
# - copy style.css, logo.png and favicon.png manually, a style.css example
# is included.
+#
# - write clone url, for example "git://git.codemadness.org/dir" to the "url"
# file for each repo.
+# - write owner of repo to the "owner" file.
+# - write description in "description" file.
#
# Usage:
# - mkdir -p htmldir && cd htmldir