From 1712809dea587adc6ab33a491529520bfdfa4a90 Mon Sep 17 00:00:00 2001
From: Kaashif Hymabaccus <kaashif@kaashif.co.uk>
Date: Wed, 19 Aug 2026 23:24:49 +0100
Subject: [PATCH] Document macOS development setup

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/README.md b/README.md
index 79e0449..5637efc 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,50 @@ degree at the University of Oxford, supervised by Dmitrii Pasechnik.
 Make sure that, when you install GAP, you installed all of the
 packages! Our package uses GRAPE and IO for some functions.
 
+### macOS with Homebrew
+
+Install GAP and its package distribution from the GAP Homebrew tap:
+
+```console
+$ brew install gap-system/gap/gap
+```
+
+This includes RepnDecomp and its required GAP packages. To check that the
+installed package loads, run:
+
+```console
+$ gap -q -c 'Print("RepnDecomp loaded: ", LoadPackage("RepnDecomp"), "\n"); QUIT;'
+RepnDecomp loaded: true
+```
+
+For development, clone the repository anywhere convenient and link the
+checkout into GAP's per-user package directory. The per-user copy takes
+precedence over the version bundled by Homebrew:
+
+```console
+$ git clone https://github.com/gap-packages/RepnDecomp.git
+$ cd RepnDecomp
+$ mkdir -p "$HOME/.gap/pkg"
+$ ln -s "$PWD" "$HOME/.gap/pkg/RepnDecomp"
+```
+
+Verify that GAP finds the development checkout rather than its bundled copy:
+
+```console
+$ gap -q -c 'LoadPackage("RepnDecomp"); Print(PackageInfo("RepnDecomp")[1].InstallationPath, "\n"); QUIT;'
+/path/to/RepnDecomp/
+```
+
+Generate the documentation tests and run the test suite from the checkout:
+
+```console
+$ gap -q < makedoc.g
+$ gap -q tst/testall.g
+```
+
+Generating the PDF version of the manual additionally requires a LaTeX
+installation, but LaTeX is not required to load RepnDecomp or run its tests.
+
 ### Latest version included with GAP
 
 If you have version 4.11.0 or later of the