Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more info to the README #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

Krutonium
Copy link

Specifically how to set up the module.

Copy link
Owner

@ners ners left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the effort to improve the readme! I'd prefer to have less conflicting information in it (just helping people to use the module) rather than list many possible configurations.

Comment on lines +36 to +45
And then import and enable it like this:
```nix
{
imports = [
inputs.nix-monitored.nixosModules.default
];

nix.monitored.enable = true;
}
```
Copy link
Owner

@ners ners Sep 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Importing and enabling the module actually replaces setting nix.package manually, as that's part of the module's implementation: https://github.com/ners/nix-monitored/blob/master/flake.nix#L108

I'd also like to mention that there is also a Darwin module available, not just a NixOS one.

Comment on lines +47 to +50
You can also import it in the overlay below by putting this line inside alongside the rest:
```
nix-monitored = inputs.nix-monitored.packages.${self.system}.default.override self;
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should probably rather be added to the module: https://github.com/ners/nix-monitored/blob/master/flake.nix#L109

@@ -44,6 +59,7 @@ nixpkgs.overlays = [
nix-direnv = super.nix-direnv.override {
nix = super.nix-monitored;
};
# Line above here if you want it.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this entire section is obsolete if you use the module, and can be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants