X-Git-Url: https://git.giacomolli.uk/onehouse/blobdiff_plain/7ef0ef316c8765dc42f704c26bf57eba28808def..c36e60046f72af3d0803943185526c27b10aa4ae:/README.rst?ds=sidebyside diff --git a/README.rst b/README.rst index 84983f4..55f1dab 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,10 @@ ########## 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 @@ -27,3 +31,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.