diff options
| -rw-r--r-- | README.md | 30 |
1 files changed, 30 insertions, 0 deletions
@@ -17,6 +17,36 @@ directory. Rui looks at the `FLAKE_EDITOR` environment variable for the editor to use when opening the flake directory, but falls back to `EDITOR` if it isn't set. +## Installation + +### Add to Flake Inputs + +```nix +{ + inputs.rui = { + url = "github:Fuwn/rui"; + inputs.nixpkgs.follows = "nixpkgs"; # Recommended + }; +} +``` + +### Add to System or Home Manager Packages + +```nix +rui.packages.${pkgs.system}.default + +# or + +(import ( + pkgs.fetchFromGitHub { + owner = "Fuwn"; + repo = "rui"; + rev = "..."; # Use the current commit revision hash + hash = "..."; # Use the current commit sha256 hash + } +)).packages.${builtins.currentSystem}.default +``` + ## `--help` ```text |