From 31eb9fde19722c2fb1348ee49fe2a18caa88eac9 Mon Sep 17 00:00:00 2001
From: Anthony Perkins <anthony@acperkins.com>
Date: Wed, 12 Oct 2022 22:08:43 +0100
Subject: [PATCH] Add docs for local builds

---
 docs/LocalBuilds.txt                          | 34 +++++++++++++++++++
 .../virt-install.txt => docs/VirtInstall.txt  |  0
 2 files changed, 34 insertions(+)
 create mode 100644 docs/LocalBuilds.txt
 rename roles/home-cli/files/virt-install.txt => docs/VirtInstall.txt (100%)

diff --git a/docs/LocalBuilds.txt b/docs/LocalBuilds.txt
new file mode 100644
index 0000000..c1da2e4
--- /dev/null
+++ b/docs/LocalBuilds.txt
@@ -0,0 +1,34 @@
+                       Local builds in ~/data/opt
+
+
+Introduction
+
+   On machines without root access, or without a package manager (such
+   as MacOS), it can be useful to build applications into the home
+   directory.
+
+
+1. Basic applications
+
+   Most applications can be installed with the following triplet:
+
+      ./configure --prefix=$HOME/data/opt/app
+      make -j4
+      make -j4 install
+
+
+2. Applications with extra libraries
+
+   If an application needs extra libraries, these can be installed into
+   the app directory first, with the same commands as above.
+
+   When the main application is built, you will need to tell the build
+   system and the application where to find the libraries. This is done
+   as so:
+
+      app=$HOME/data/opt/app
+      ./configure --prefix=$app \
+                  CFLAGS="-I$app/include" \
+                  LDFLAGS="-L$app/lib -Wl,-rpath $app/lib"
+      make -j4
+      make -j4 install
diff --git a/roles/home-cli/files/virt-install.txt b/docs/VirtInstall.txt
similarity index 100%
rename from roles/home-cli/files/virt-install.txt
rename to docs/VirtInstall.txt