Poll and command shared Alamo thermostats

[onehouse] / README.rst

diff --git a/README.rst b/README.rst
index 84983f4d9610da4f21628c814dbd018c7d9c3bcb..55f1dab80949312a10136e1a8c428ab8c94d3996 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -3,6 +3,10 @@
 ##########
 
 OneHouse is one program that controls a whole house. Linux is supported.
 ##########
 
 OneHouse is one program that controls a whole house. Linux is supported.

+The command runs an empty driver list and stops on SIGINT or SIGTERM.
+``doc/driver.rst`` describes the framework and ``doc/mqtt.rst`` defines
+its wire contract. ``doc/m31.rst`` and ``doc/alamo.rst`` describe the
+device integrations.

 
 *************
  Development
 
 *************
  Development


@@ -27,3 +31,6 @@ Format all files, then run the checks:
    nix flake check
 
 ``AGENTS.md`` holds the rules for work in this repository.
    nix flake check
 
 ``AGENTS.md`` holds the rules for work in this repository.

+
+Run the command with ``nix run``. It waits for a signal without starting
+an integration or a broker.