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

   1 #########
   2  OneChat
   3 #########
   4
   5 OneChat is a Go program. It prints its name. It is in early development.
   6 Linux is supported.
   7
   8 *************
   9  Development
  10 *************
  11
  12 Nix supplies the Go toolchain and all tools. Enter the development shell
  13 with direnv:
  14
  15 .. code:: console
  16
  17    direnv allow
  18
  19 Or enter it directly:
  20
  21 .. code:: console
  22
  23    nix develop
  24
  25 The shell sets ``ONECHAT_DIR`` to ``.devenv/onechat`` in the checkout,
  26 unless it is already set. Development data goes there, and Git ignores
  27 ``.devenv``.
  28
  29 Build and run:
  30
  31 .. code:: console
  32
  33    nix build
  34    ./result/bin/onechat
  35
  36 Format and check all files:
  37
  38 .. code:: console
  39
  40    bin/format
  41    bin/check
  42    nix flake check