Skip to content

Commit

Permalink
chore: update README.md with Nix flake instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
t56k committed Mar 12, 2024
1 parent 29c00eb commit 4dcd91f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,29 @@ The latest release is available
Download the archive that is appropriate for your platform and extract the
binary into your `$PATH`. A common valid path location is `/usr/local/bin`.

#### Using Nix flakes
To build from `master` on flaked Nix platforms add this repo to your inputs:

```
inputs = {
nixpkgs.url = "nixpkgs/nixos-unstable";
gitu.url = "github:altsem/gitu";
gitu.inputs.nixpkgs.follows = "nixpkgs";
};
```

Then wherever you install your packages (i.e., `home-manager`):

```
{ inputs, pkgs, lib, system, ... }:
{
home.packages = with pkgs;
[
inputs.gitu.packages.${system}.default
];
}
```

### Configuration
The environment variables `GIT_EDITOR`, `VISUAL` or `EDITOR` (checked in this order) dictate which editor Gitu will open.

Expand Down

0 comments on commit 4dcd91f

Please sign in to comment.