X-Git-Url: https://git.giacomolli.uk/onehouse/blobdiff_plain/7ef0ef316c8765dc42f704c26bf57eba28808def..f9e4f329fbb3381ad8f16ade26a62560e3c2b951:/README.rst?ds=inline diff --git a/README.rst b/README.rst index 84983f4..69b14d2 100644 --- a/README.rst +++ b/README.rst @@ -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. ``doc/m31.rst`` describes the M31 integration. ************* 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.