diff options
| author | Fuwn <[email protected]> | 2024-10-15 00:17:35 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-10-15 00:17:35 -0700 |
| commit | 6cec94a1ddaf9c0ec3f569cbc9d6ece387242983 (patch) | |
| tree | 46dd6c341927796b8e38ca403f49309312d160d6 | |
| parent | 63989c58564c16d388ee78bc85a6a283a2125ff7 (diff) | |
| download | yae-6cec94a1ddaf9c0ec3f569cbc9d6ece387242983.tar.xz yae-6cec94a1ddaf9c0ec3f569cbc9d6ece387242983.zip | |
docs(readme): expand on installation instructions
| -rw-r--r-- | README.md | 33 |
1 files changed, 29 insertions, 4 deletions
@@ -71,11 +71,36 @@ yae update zen-browser-twilight-bin ## Installation -Follow the installation instructions at [Tsutsumi](https://github.com/Fuwn/tsutsumi), -which provides both flake and flake-less installation options. +You can either install Yae through the flake that this repository exposes or +through [Tsutsumi](https://github.com/Fuwn/tsutsumi). -Alternatively, without flake-less support, install the -`inputs.yae.packages.${pkgs.system}.yae` package exposed by this flake. +[Tsutsumi](https://github.com/Fuwn/tsutsumi) provides both flake and flake-less installation +options, while this repsitory only provides installation support through flakes using the +exported `inputs.yae.packages.${pkgs.system}.yae` package. + +<details closed> + <summary>Click here to see a minimal Nix flake that exposes a development shell with Yae bundled.</summary> + +```nix +# Enter the development shell using `nix develop --impure` (impure is used here because `nixpkgs` internally +# assigns `builtins.currentSystem` to `nixpkgs.system` for the sake of simplicity in this example) +{ + inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + + inputs.tsutsumi = { + url = "github:Fuwn/tsutsumi"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + + outputs = { nixpkgs, tsutsumi, self }: + let pkgs = import nixpkgs { inherit self; }; in { + devShells.${pkgs.system}.default = pkgs.mkShell { + buildInputs = [ tsutsumi.packages.${pkgs.system}.yae ]; + }; + }; +} +``` +</details> ### Integrating with Nix |