Skip to content

Commit

Permalink
README: add instructions for branch selection (stable/unstable)
Browse files Browse the repository at this point in the history
  • Loading branch information
GaetanLepage committed Aug 18, 2023
1 parent ad3598c commit 07af771
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,11 @@ If you have any question, please use the [discussions page](https://github.com/n

## Installation

NixVim needs to be installed with a compatible nixpkgs version.
This means that the `main` branch of NixVim requires to be installed with `nixos-unstable`.

If you want to use NixVim with nixpkgs 23.05 you should use the `nixos-23.05` branch.
**WARNING !**
> NixVim needs to be installed with a compatible nixpkgs version.
> This means that the `main` branch of NixVim requires to be installed with `nixos-unstable`.
>
> If you want to use NixVim with nixpkgs 23.05 you should use the `nixos-23.05` branch.
### Without flakes
NixVim now ships with `flake-compat`, which makes it usable from any system.
Expand All @@ -51,6 +52,8 @@ To install it, edit your home-manager (or NixOS) configuration:
let
nixvim = import (builtins.fetchGit {
url = "https://github.com/nix-community/nixvim";
# If you are not running an unstable channel of nixpkgs, select the corresponding branch of nixvim.
# ref = "nixos-23.05";
});
in
{
Expand Down Expand Up @@ -88,7 +91,13 @@ flakes, just add the nixvim input:
```nix
{
# ...
inputs.nixvim.url = "github:nix-community/nixvim";
inputs.nixvim = {
url = "github:nix-community/nixvim";
# If you are not running an unstable channel of nixpkgs, select the corresponding branch of nixvim.
# url = "github:nix-community/nixvim/nixos-23.05";
inputs.nixpkgs.follows = "nixpkgs";
};
}
```

Expand Down

0 comments on commit 07af771

Please sign in to comment.