From cf98ee57b5fc48feae076142bf35e41679764503 Mon Sep 17 00:00:00 2001
From: Andy Holmes <andrew.g.r.holmes@gmail.com>
Date: Mon, 25 Jul 2022 14:25:26 -0700
Subject: [PATCH] docs: add a section with more explicit details about running
 tests

Running tests with the `flatpak-builder` action is fairly simple, but
has some gotchas if you're not familiar with the process.

Add a section with some more explicit examples, detailing what the
developer needs to do to ensure the expected results.

closes #86
---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index df41a541..c0aff97e 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,53 @@ jobs:
         arch: ${{ matrix.arch }}
 ```
 
+#### Building for Automated Tests
+
+As described in the [Inputs](#inputs) documentation, specifying `run-tests: true` will amend the Flatpak manifest to enable Network and X11 access automatically. Any other changes to the manifest must be made manually, such as building the tests (e.g. `-Dtests=true`) or any other options (e.g. `--buildtype=debugoptimized`).
+
+Most developers will want to run tests on pull requests, before merging into the main branch of a repository. To ensure your manifest is building the correct code, you should set the `sources` entry for your project to `"type": "dir"` with the `path` key relative to the manifest's location in the repository.
+
+In the example below, the manifest is located at `/build-aux/flatpak/org.gnome.zbrown.Palette.json`, so the `path` key is set to `../../`. If the manifest were in the project root instead, the correct usage would be `"path": "./"`.
+
+```json
+{
+    "app-id" : "org.gnome.zbrown.Palette",
+    "runtime" : "org.gnome.Platform",
+    "runtime-version" : "master",
+    "sdk" : "org.gnome.Sdk",
+    "command" : "org.gnome.zbrown.Palette",
+    "finish-args" : [
+        "--share=ipc",
+        "--device=dri",
+        "--socket=fallback-x11",
+        "--socket=wayland",
+        "--filesystem=xdg-run/dconf",
+        "--filesystem=~/.config/dconf:ro",
+        "--talk-name=ca.desrt.dconf",
+        "--env=DCONF_USER_CONFIG_DIR=.config/dconf"
+    ],
+    "modules" : [
+        {
+            "name" : "palette",
+            "buildsystem" : "meson",
+            "config-opts" : [
+                "--prefix=/app",
+                "--buildtype=debugoptimized",
+                "-Dtests=true"
+            ],
+            "sources" : [
+                {
+                    "name" : "palette",
+                    "buildsystem" : "meson",
+                    "type" : "dir",
+                    "path" : "../../"
+                }
+            ]
+        }
+    ]
+}
+```
+
 ### Deployment stage
 
 If you want to deploy the successfully built Flatpak application to a remote repository