christoph/flake-nixinator
1
Fork 0
Code Activity

Readme: Update readme

Browse Source
This commit is contained in:
Christoph Urlacher
2024-06-04 22:34:19 +02:00
parent 5178993594
commit bf8661762c
1 changed files with 17 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,44 +1,40 @@
# NixOS Configuration
This is my modular NixOS configuration, using Hyprland for a lightweight desktop.
Modular NixOS configuration, using Hyprland for a lightweight desktop.
![](Foggy-Lake.png)
To install, run ``nixos-rebuild`` with the ``--flake`` parameter from the ``NixFlake`` directory: ``nixos-rebuild switch --flake .#nixinator``.
To install, run `nixos-rebuild` with the `--flake` parameter from the `NixFlake` directory: `nixos-rebuild switch --flake .#nixinator`.
## NixFlake/system
This folder contains all the system configurations.
Contains all the system configurations.
- There is a common configuration used for all systems: ``NixFlake/system/default.nix``
- Every system has its own special configuration: ``NixFlake/system/<hostname>/default.nix``
- System modules are located in ``NixFlake/system/modules``
- There is a common configuration used for all systems: `NixFlake/system/default.nix`
- Every system has its own special configuration: `NixFlake/system/<hostname>/default.nix`
- System modules are located in `NixFlake/system/modules`
When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported.
When creating a NixOS configuration inside the `NixFlake/flake.nix` the common configuration is imported.
Because the hostname is propagated to the common configuration, it can import the host-specific config by itself.
## NixFlake/home
This folder contains all the home-manager configurations.
Contains all the home-manager configurations.
- There is a common configuration for each user: ``NixFlake/home/<username>/default.nix``
- There is a configuration for a single system of this user: ``NixFlake/home/<username>/<hostname>/default.nix``
- Home-Manager modules are located in ``NixFlake/home/modules``
- There is a common configuration for each user: `NixFlake/home/<username>/default.nix`
- There is a configuration for a single system of this user: `NixFlake/home/<username>/<hostname>/default.nix`
- Home-Manager modules are located in `NixFlake/home/modules`
When creating a NixOS configuration inside the ``NixFlake/flake.nix`` the common configuration is imported.
When creating a NixOS configuration inside the `NixFlake/flake.nix` the common configuration is imported.
Because the hostname is propagated to the common configuration, it can import the host-specific config by itself.
## NixFlake/derivations
This folder contains all the stuff I packaged.
Each derivation is loaded into ``NixFlake/derivations/default.nix``.
Contains all the stuff I packaged.
Each derivation is loaded into `NixFlake/derivations/default.nix`.
## NixFlake/overlays
This folder contains (not at the moment) all overlays.
The ``NixFlake/overlays/default.nix`` imports all of the overlays and all of the derivations.
It is then imported by the toplevel ``NixFlake/flake.nix``, to make everything available to the system/home configurations.
## NixFlake/docs
This folder contains automatically generated static documentation sites for my Home-Manager modules.
Contains (not at the moment) all overlays.
The `NixFlake/overlays/default.nix` imports all of the overlays and all of the derivations.
It is then imported by the toplevel `NixFlake/flake.nix`, to make everything available to the system/home configurations.