From d3f12340e153af9ea7c71c80d72e4c163d1ef15f Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Mon, 3 Jun 2024 15:54:07 +0100 Subject: [PATCH] readme: put installation instruction in `
` --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 757325e7..faebc870 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,11 @@ If you have any question, please use the [discussions page](https://github.com/n > > If you want to use NixVim with nixpkgs 23.11 you should use the `nixos-23.11` branch. -### Without flakes +For more detail, see the [Installation](https://nix-community.github.io/nixvim/install.html#installation) section of our documentation. + +
+ Without flakes + NixVim now ships with `flake-compat`, which makes it usable from any system. To install it, edit your home-manager (or NixOS) configuration: @@ -76,7 +80,11 @@ in } ``` -### Using flakes +
+ +
+ Using flakes + This is the recommended method if you are already using flakes to manage your system. To enable flakes, add this to `/etc/nixos/configuration.nix` @@ -111,6 +119,8 @@ You can now access the module using `inputs.nixvim.homeManagerModules.nixvim`, for a home-manager installation, `inputs.nixvim.nixosModules.nixvim`, for NixOS, and `inputs.nixvim.nixDarwinModules.nixvim` for nix-darwin. +
+ ## Usage NixVim can be used in four ways: through the home-manager, nix-darwin, NixOS modules, and standalone through the `makeNixvim` function. To use the modules, just import the