git.giacomolli.uk - onehouse/blob - README.rst

   1 ##########
   2  OneHouse
   3 ##########
   4
   5 OneHouse is one program that controls a whole house. Linux is supported.
   6 The command runs an empty driver list and stops on SIGINT or SIGTERM.
   7 ``doc/driver.rst`` describes the framework and ``doc/mqtt.rst`` defines
   8 its wire contract. ``doc/m31.rst`` describes the M31 integration.
   9
  10 *************
  11  Development
  12 *************
  13
  14 Nix supplies the toolchain and every tool. Enter the development shell:
  15
  16 .. code:: console
  17
  18    nix develop
  19
  20 With direnv, the shell loads when you enter the checkout. The shell sets
  21 the Git hooks path to ``.githooks``.
  22
  23 Format all files, then run the checks:
  24
  25 .. code:: console
  26
  27    bin/format
  28    bin/check
  29    nix build
  30    nix flake check
  31
  32 ``AGENTS.md`` holds the rules for work in this repository.
  33
  34 Run the command with ``nix run``. It waits for a signal without starting
  35 an integration or a broker.