From 9e36dbd23fb48cf284ded931614942a4a07b735d Mon Sep 17 00:00:00 2001
From: Daniel Borchmann <daniel@algebra20.de>
Date: Sun, 20 Dec 2020 09:56:51 +0100
Subject: [PATCH] Add setup instructions for quilt to README

---
 .gitignore |  1 +
 README.md  | 38 +++++++++++++++++++++++++++++++++++++-
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index e52136d..860041a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 # ignore quilt cache directory
 /.pc/
+/README.html
diff --git a/README.md b/README.md
index 3f07d05..6d9d186 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,8 @@ is either included as a git-submodule (preferred) or, if that is not possible,
 directly contained in this repository.  Additionally, local modifications of
 certain modes (like disabling particular features) are included as separate
 patches in the `patches` directory.  These can be applied with `quilt push -a`
-Before updating mods, unapply the patches with `quilt pop -a`.
+Before updating mods, unapply the patches with `quilt pop -a`.  See also section
+on [setting up git](#git-setup) below.
 
 Some standard extension mods are not included here, because they are shipped
 with Debian.  Run the following command to satisfy these dependencies:
@@ -36,3 +37,38 @@ again.  Enjoy! ☺
 For licenses and copyrights see the corresponding mods.  All that remains is
 licensed under an MIT License.
 
+<a name="git-setup">Setting up git hooks for remote updating</a>
+-----------------------------------------------------------------
+
+To automatically update a local copy of this git repository on updates, perform
+the following configuration
+
+- Make the local copy update its worktree on push, instead of barfing:
+
+  ~~~sh
+  git config receive.denyCurrentBranch updateInstead
+  ~~~
+
+- Remove `quilt` patches on `pre-receive`, i.e., before receiving updates:
+
+  ~~~sh
+  cat <<SCRIPT > .git/hooks/pre-receive
+  #!/bin/sh
+
+  quilt pop -a
+  SCRIPT
+  chmod +x .git/hooks/pre-receive
+  ~~~
+
+- After pushing, update all submodules, apply patches, and fix permissions:
+
+  ~~~sh
+  cat <<SCRIPT > .git/hooks/post-update
+  #!/bin/sh
+  
+  git submodule update --init
+  quilt push -a 
+  chmod -R a+rX .
+  SCRIPT
+  chmod +x .git/hooks/post-update
+  ~~~