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
   7 *************
   8  Development
   9 *************
  10
  11 Nix supplies the toolchain and every tool. Enter the development shell:
  12
  13 .. code:: console
  14
  15    nix develop
  16
  17 With direnv, the shell loads when you enter the checkout. The shell sets
  18 the Git hooks path to ``.githooks``.
  19
  20 Format all files, then run the checks:
  21
  22 .. code:: console
  23
  24    bin/format
  25    bin/check
  26    nix build
  27    nix flake check
  28
  29 ``AGENTS.md`` holds the rules for work in this repository.