From ca41a1b69beac9dec488f7ef30f3f953e2be2a6c Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Sun, 13 Nov 2022 12:25:22 +0100
Subject: [PATCH] Explain hci effect tests

---
 dev/flake-module.nix |  1 +
 dev/tests/README.md  | 15 +++++++++++++++
 2 files changed, 16 insertions(+)
 create mode 100644 dev/tests/README.md

diff --git a/dev/flake-module.nix b/dev/flake-module.nix
index 95dcb4a..40fe958 100644
--- a/dev/flake-module.nix
+++ b/dev/flake-module.nix
@@ -12,6 +12,7 @@
       nativeBuildInputs = [
         pkgs.nixpkgs-fmt
         pkgs.pre-commit
+        pkgs.hci
       ];
       shellHook = ''
         ${config.pre-commit.installationScript}
diff --git a/dev/tests/README.md b/dev/tests/README.md
new file mode 100644
index 0000000..73c85f6
--- /dev/null
+++ b/dev/tests/README.md
@@ -0,0 +1,15 @@
+
+# Running the tests
+
+These tests can be run locally with the `hci effect run` command. This gives
+the tests access to a proper nix daemon and the network.
+
+Designed for convenient deployments, it needs some information from git. You
+may use `--no-token` to disable this functionality if you're getting errors, or
+if you're asked to log in.
+
+Example:
+
+```console
+hci effect run --no-token default.effects.tests.template
+```