stagit: generate tar archive for each repo

[stagit.git] / README

diff --git a/README b/README
index d916cc8c5487b7bf23e1d819ced9f872bca370f6..e8369940f43d9ee808d25a1fdd8236fb2d05fc83 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,10 @@
 stagit
-======
+------
 
-static git page generator
+static git page generator. personal fork with fast syntax highlighting via
+Chroma and some style and quality of life improvements.
 
+It generates static HTML pages for a git repository.
 
 Usage
 -----
@@ -14,11 +16,11 @@ Make files per repository:
 
 Make index file for repositories:
 
-       $ stagit-index repodir1 repodir2 repodir3 > index.html
+       $ stagit-index repodir1 repodir2 repodir3
 
 
-Install
--------
+Build and install
+-----------------
 
 $ make
 # make install
@@ -27,10 +29,11 @@ $ make
 Dependencies
 ------------
 
-- libgit2 (v0.22+).
-- libc (tested with OpenBSD, FreeBSD, Linux: glibc and musl).
 - C compiler (C99).
-- make
+- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
+- libgit2 (v0.22+).
+- POSIX make (optional).
+- Python3, pip.
 
 
 Documentation
@@ -123,8 +126,14 @@ Create .tar.gz archives by tag
        name="stagit"
        mkdir -p archives
        git tag -l | while read -r t; do
-               f="archives/$name-$t.tar.gz"
-               test -f "$f" || git archive --format tar.gz "$t" -o "$f"
+               f="archives/${name}-$(echo "${t}" | tr '/' '_').tar.gz"
+               test -f "${f}" && continue
+               git archive \
+                       --format tar.gz \
+                       --prefix "${t}/" \
+                       -o "${f}" \
+                       -- \
+                       "${t}"
        done