Skip to content

Commit

Permalink
Revise Nix instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
WombatFromHell committed Feb 1, 2025
1 parent 14798ab commit 6e2e500
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,21 @@ open-source program.**

## Nix/NixOS Install Instructions

If you want to use the cachix build cache you can run the following command
to add the substituter and public key to your trusted-substituters list on NixOS:

`sudo nix flake check github:WombatFromHell/veridian-controller`

Then integrate this repo as a flake input in your flake.nix like so:

```nix
# Your flake.nix should look something like this
{
description = "My configuration flake";
description = "My NixOS configuration flake";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
# nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; # if using standalone
veridian.url = "github:WombatFromHell/veridian-controller";
};
Expand All @@ -34,7 +42,7 @@ open-source program.**
hostname = nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
./configuration.nix # Your system configuration.
./configuration.nix # Your config with 'hardware.nvidia' enabled
veridian.nixosModules.default # ADD OUR DEFAULT MODULE
];
Expand All @@ -48,7 +56,7 @@ open-source program.**
users = ["<change this to your username>"];
commands = [
{
command = "${pkgs.linuxPackages.nvidia_x11.bin}/bin/nvidia-settings";
command = "${config.hardware.nvidia.package.bin}/bin/nvidia-settings";
options = ["NOPASSWD"];
}
];
Expand Down

0 comments on commit 6e2e500

Please sign in to comment.