Update Readme

LovingMelody · Apr 27, 2024 · 8e6ee6c · 8e6ee6c
1 parent b446a58
commit 8e6ee6c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -21,6 +21,20 @@ flakes please see the
 | [star-citizen-helper](./pkgs/star-citizen-helper)                                   | Star Citizen helper utility, clears shaders if an update is detected                                                                   |
 | [lug-helper](./pkgs/lug-helper)                                                     | Star Citizen's Linux Users Group Helper Script. Includes a setup script if you wish to use lutris instead of the star-citizen package. |
 
+### Cachix
+
+Build caches are available
+
+```nix
+# configuration.nix
+{
+    nix.settings = {
+        substituters = ["https://nix-citizen.cachix.org"];
+        trusted-public-keys = ["nix-citizen.cachix.org-1:lPMkWc2X8XD4/7YPEEwXKKBg+SVbYTVrAaLA2wQTKCo="];
+    };
+}
+```
+
 ### Flakes
 
 Add these packages to your `home.packages` or `environment.systemPackages` after

diff --git a/modules/nixos/star-citizen/README.md b/modules/nixos/star-citizen/README.md
@@ -11,7 +11,7 @@ NameSpace: nix-citizen.starCitizen
   inputs = {
        nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
        nix-citizen.url = "github:LovingMelody/nix-citizen";
-       # Optional
+       # Optional - (Invalidates build cache if you use the cachix section)
        nix-gaming.url = "github:fufexan/nix-gaming";
        nix-citizen.inputs.nix-gaming.follows = "nix-gaming";
   };
@@ -23,6 +23,11 @@ NameSpace: nix-citizen.starCitizen
                ./configuration.nix
                nix-citizen.nixosModules.StarCitizen
                {
+                   # Cachix setup
+                    nix.settings = {
+                        substituters = ["https://nix-citizen.cachix.org"];
+                        trusted-public-keys = ["nix-citizen.cachix.org-1:lPMkWc2X8XD4/7YPEEwXKKBg+SVbYTVrAaLA2wQTKCo="];
+                    };
                    nix-citizen.starCitizen = {
                        # Enables the star citizen module
                        enable = true;