summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustaf Rydholm <gustaf.rydholm@gmail.com>2022-02-12 16:39:39 +0100
committerGustaf Rydholm <gustaf.rydholm@gmail.com>2022-02-12 16:39:39 +0100
commitbcbaea756975df1af8b9a1738a73a28cf4257976 (patch)
treea36ebed23dac134cb0e01e0156b028ea5429b0a5
parent147bb8276b419ff8e13052877f4ddc58064596ed (diff)
feat: add README
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..70a30af
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# GitHome
+
+Install scripts for generating new repositories and making static websites with `stagit`.
+
+## Prerequisites
+
+- A [git server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) on the machine
+- [stagit](https://codemadness.org/stagit.html)
+
+## Usages
+
+- `stagit-new-repo` a script for creating a new git repository and index it with stagit
+- `stagit-gen-index` re-index all repositories