diff options
| author | Fuwn <[email protected]> | 2024-10-04 11:04:08 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-10-04 11:04:08 -0700 |
| commit | 8610461ff6a6006f8cc8ce50400bcd9bca91ca72 (patch) | |
| tree | a5b290e6f5834d296cccf6ae0cfa54849010de4e | |
| parent | feat(flake): bump gigi (diff) | |
| download | tsutsumi-8610461ff6a6006f8cc8ce50400bcd9bca91ca72.tar.xz tsutsumi-8610461ff6a6006f8cc8ce50400bcd9bca91ca72.zip | |
docs(readme): add overlay instructions
| -rw-r--r-- | README.md | 20 |
1 files changed, 19 insertions, 1 deletions
@@ -64,7 +64,7 @@ running `nix run github:Fuwn/tsutsumi#rui`. (or any other package in place of ```nix # For flakes users -tsutsumi.packages.${pkgs.system}.rui # Or any other package +inputs.tsutsumi.packages.${pkgs.system}.rui # Or any other package # For non-flakes users (import ( @@ -77,6 +77,24 @@ tsutsumi.packages.${pkgs.system}.rui # Or any other package )).packages.${builtins.currentSystem}.rui # Or any other package ``` +### Use as a Nix Packages Overlay + +Overlaying Tsutsumi allows you to simplify the mass installation of Tsutsumi +packages. For example, `inputs.tsutsumi.packages.${pkgs.system}.rui` becomes +`pkgs.tsutsumi.rui`. + +```nix +import nixpkgs { + system = "your_system_attribute"; + + overlays = [ + (_: _: { + tsutsumi = inputs.tsutsumi.packages.${system}; + }) + ]; +} +``` + ## Credits This flake includes a modified version of |