shell.nix

let
  name = "Deterload";
  pkgs = import <nixpkgs> {};
  my-python3 = pkgs.python3.withPackages (python-pkgs: [
    # for docs
    python-pkgs.pydot
  ]);
  h_content = builtins.toFile "h_content" ''
    # ${pkgs.lib.toUpper "${name} usage tips"}

    ## Configuration

    From higher priority to lower priority:

    * Configure by CLI:
      * `nom-build ... --arg <key> <value> ...`
      * `nom-build ... --argstr <key> <strvalue> ...`
      * E.g: Generate spec2006 simpoint-guided checkpoints using given source code:
        * `nom-build examples/spec2006/ --arg src <PATH_TO_SPEC2006> -A cpts-simpoint`
    * Configure by a file: see `examples/*/config.nix`

    ## Generation

    * Generate the simpoint-guided checkpoints for a given <benchmark> into `result/`:
      * `nom-build examples/<benchmark> -A cpts-simpoint`
      * E.g: Generate simpoint-guided checkpoints for openblas:
        * `nom-build examples/openblas -A cpts-simpoint`

    ## Documentation

    * Generate html doc into `book/`
      * `make doc`
  '';
  _h_ = pkgs.writeShellScriptBin "h" ''
    ${pkgs.glow}/bin/glow ${h_content}
  '';
in
pkgs.mkShell {
  inherit name;
  packages = [
    _h_
    pkgs.nix-output-monitor
    pkgs.mdbook
    pkgs.graphviz
    pkgs.glibcLocales
    my-python3
  ];
  shellHook = ''
    export LOCALE_ARCHIVE=${pkgs.glibcLocales}/lib/locale/locale-archive
    h
  '';
}