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`` and ``doc/alamo.rst`` describe the
   9 device integrations.
  10
  11 *************
  12  Development
  13 *************
  14
  15 Nix supplies the toolchain and every tool. Enter the development shell:
  16
  17 .. code:: console
  18
  19    nix develop
  20
  21 With direnv, the shell loads when you enter the checkout. The shell sets
  22 the Git hooks path to ``.githooks``.
  23
  24 Format all files, then run the checks:
  25
  26 .. code:: console
  27
  28    bin/format
  29    bin/check
  30    nix build
  31    nix flake check
  32
  33 ``AGENTS.md`` holds the rules for work in this repository.
  34
  35 Run the command with ``nix run``. It waits for a signal without starting
  36 an integration or a broker.