Skip to content

README talks about classic-style Nix expressions but provides commands that use flakes #1538

@Jayman2000

Description

@Jayman2000

The “Building Hydra” section of README.md says:

You can build Hydra via nix-build using the provided default.nix:

$ nix build

That quote tells you that you can use nix-build but then gives you a command that uses nix build instead. Additionally, it says that Hydra can be built using the default.nix file, but the provided nix build command will use flake.nix instead of default.nix. Additionally, the “Development Environment” section of README.md says:

You can use the provided shell.nix to get a working development environment:

$ nix develop
$ ln -svf ../../../build/src/bootstrap src/root/static/bootstrap
$ ln -svf ../../../build/src/fontawesome src/root/static/fontawesome
$ ln -svf ../../../../build/src/flot src/root/static/js/flot
$ meson setup build
$ ninja -C build

That quote says that you can use shell.nix, but the provided nix develop command will use flake.nix instead of shell.nix.

It would be better if either

  • the README always used classic Nix terminology and commands or
  • the README always used flake terminology and commands.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions