]> git.giacomolli.uk - onehouse/blobdiff - README.rst
Queue device commands and replay first results
[onehouse] / README.rst
index 84983f4d9610da4f21628c814dbd018c7d9c3bcb..41146534bf3c4e71b56283bf69df5c6aab8059b7 100644 (file)
@@ -3,6 +3,9 @@
 ##########
 
 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.
 
 *************
  Development
@@ -27,3 +30,6 @@ Format all files, then run the checks:
    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.