22
0
mirror of https://github.com/SuperSandro2000/nixos-modules.git synced 2024-06-08 17:24:07 +02:00
nixos-modules/README.md
Sandro Jäckel f2d0ff24d0
Update readme
- add usage, design idea
- update other projects
2023-01-03 05:14:35 +01:00

33 lines
645 B
Markdown

# nixos-modules
Opinionated shared NixOS configurations.
## Usage
Add or merge the following settings to your `flake.nix`:
```nix
{
inputs = {
nixos-modules.url = "github:SuperSandro2000/nixos-modules";
};
outputs = { nixos-modules }: {
nixosConfigurations.HOSTNAME = {
modules = [
nixos-modules.nixosModule
];
};
}
```
## Design
* Modules should never change the configuration without setting an option
* Unless the global overwrite ``opinionatedDefaults = true`` is set which activates most settings.
## Similar projects
* https://github.com/numtide/srvos
* https://gitea.c3d2.de/C3D2/nix-user-module