From 07af7710e297308a553f09f6ceeb729aa5b5a27c Mon Sep 17 00:00:00 2001 From: Gaetan Lepage Date: Fri, 18 Aug 2023 10:53:02 +0200 Subject: [PATCH] README: add instructions for branch selection (stable/unstable) --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1bb867f4..7755e57c 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 { @@ -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"; + }; } ```