Release Ver 1.2.0

Documentation/How-to-Homemanager.md

@@ -0,0 +1,89 @@
+# How-to: Home Manager → Legacy Nyx branch
+
+**Why:** Nyx is moving to a NixOS module. If you’re on Home Manager today and want stability, pin Nyx to the “legacy” state (by `rev`) or a local checkout.
+
+---
+
+If you forgot how to setup the home.nix see the [Example](./Legacy/example-home.nix)
+
+--- 
+
+## How to still use the Homemanager Import:
+
+### Option A — Pin Nyx to a specific revision
+
+
+```nix
+{
+  description = "EXAMPLE-flake";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    home-manager.url = "github:nix-community/home-manager";
+    home-manager.inputs.nixpkgs.follows = "nixpkgs";
+
+    # Old:
+    # nyx.url = "github:Peritia-System/Nyx-Tools";
+
+    # Legacy pin (replace rev with the legacy commit you want):
+    nyx.url = "github:Peritia-System/Nyx-Tools?rev=7f73899c918a09bae789306fe3fa73dbc2d83997";
+  };
+
+  outputs = inputs @ { nixpkgs, home-manager, nyx, ... }: {
+    nixosConfigurations = {
+      default = nixpkgs.lib.nixosSystem {
+        system = "x86_64-linux";
+        specialArgs = { inherit inputs self; host = "default"; };
+        modules = [
+          ./Configurations/Hosts/Default/configuration.nix
+        ];
+      };
+    };
+  };
+}
+```
+
+
+### Option B — Pin to a local checkout 
+
+This will **never** change unless you `git pull` inside the repo.
+
+1. Clone:
+
+```bash
+git clone https://github.com/Peritia-System/Nyx-Tools /path/to/repo
+cd  /path/to/repo
+git reset --hard 7f73899c918a09bae789306fe3fa73dbc2d83997 # or any other commit you want 
+   
+```
+
+2. Point your flake at the local path:
+
+```nix
+{
+  description = "EXAMPLE-flake";
+
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    home-manager.url = "github:nix-community/home-manager";
+    home-manager.inputs.nixpkgs.follows = "nixpkgs";
+
+    # Local path (no updates unless you update the repo)
+    nyx.url = "/path/to/repo/";
+  };
+
+  outputs = inputs @ { nixpkgs, home-manager, nyx, ... }: {
+    nixosConfigurations = {
+      default = nixpkgs.lib.nixosSystem {
+        system = "x86_64-linux";
+        specialArgs = { inherit inputs self; host = "default"; };
+        modules = [
+          ./Configurations/Hosts/Default/configuration.nix
+        ];
+      };
+    };
+  };
+}
+```
+
+

Documentation/Legacy/example-home.nix

@@ -0,0 +1,56 @@
+{ config, nixDirectory, username, pkgs, inputs, ... }:
+
+{
+
+  ################################################################
+  # Module Imports
+  ################################################################
+
+  imports = [
+    # Other Home Manager Modules 
+    # ......
+    inputs.nyx.homeManagerModules.default
+  ];
+
+  ################################################################
+  # Nyx Tools Configuration
+  ################################################################
+
+nyx = {
+  
+  enable = true;
+  inherit username nixDirectory;
+  logDir = "/home/${username}/.nyx/logs";
+  autoPush = false;
+
+  nyx-rebuild = {
+    enable = true;
+    editor = "nvim";
+    formatter = "alejandra";
+    enableAlias = false;
+    startEditor = false;
+  };
+  
+  nyx-cleanup = {
+    enable = true;
+    keepGenerations = 5;
+    enableAlias = false;
+  };
+  
+  nyx-tool = {
+    enable = true;
+  };
+
+  nyx-tui = {
+    enable          = true;
+    enableAlias     = false;
+  };
+}
+  ################################################################
+  # Basic Home Manager Setup
+  ################################################################
+
+  home.username = username;
+  home.homeDirectory = "/home/${username}";
+  home.stateVersion = "25.05";
+}

Documentation/main.md

@@ -16,6 +16,7 @@
 
 ```
 Nyx-Tools
+├── legacy-nyx              # will be removed
 ├── nyx
 │   ├── bash
 │   │   ├── nyx-cleanup.sh
@@ -28,6 +29,8 @@ Nyx-Tools
 │   ├── nyx-tool.nix
 │   └── nyx-tui.nix
 └── other/
+      ├── example            # Example configurations
+      └── ...                # Other
 ```
 
 ---
@@ -74,18 +77,19 @@ Nyx-Tools
 }
 ```
 
-### 2. Import Nyx into Home Manager
+### 2. Import Nyx into configuration-nix
 
 ```nix
-# home.nix
+# configuration-nix
 {
   config,
   inputs,
+  # and all the others you have
   ...
 }:
 {
   imports = [
-    inputs.nyx.homeManagerModules.default
+    inputs.nyx.nixosModules.default
   ];
 }
 ```
@@ -97,7 +101,12 @@ Nyx-Tools
   nyx = {
     
     enable = true;
-    inherit username nixDirectory;
+    # Your username
+    username = "alex";
+    # Set this to where you have your NixOS Configuration. Standard /etc/nixos
+    nixDirectory = "/home/${username}/my-nixos-config"; 
+    # or inherit it
+    # inherit username nixDirectory;
     logDir = "/home/${username}/.nyx/logs";
     autoPush = false;
 
@@ -116,7 +125,7 @@ Nyx-Tools
     };
     
     nyx-tool = {
-      enable = true;
+      enable = true;  # must be enabled for others
     };
 
     nyx-tui = {
@@ -128,9 +137,9 @@ Nyx-Tools
 }
 ```
 
-> ⚠️ **Note**: `nixDirectory` must be a **full path** to your flake repo (e.g., `/home/${username}/NixOS/Nyx-Tools`).
+> ⚠️ **Note**: `nixDirectory` must be a **full path** to your flake repo (e.g., `/home/${username}/NixOS`).
 
-See `other/example/example-home.nix` for a working example.
+See [Example-Configuration.nix](./../other/example/example-configuration.nix)/[Example-Flake.nix](./../other/example/example-flake.nix) for a working example.
 
 ---
 
@@ -175,8 +184,6 @@ nyx-tui --pretty
 
 ```
 
-
-
 ---
 
 ## Module Options