readme: put installation instruction in <details>

This commit is contained in:
Matt Sturgeon 2024-06-03 15:54:07 +01:00
parent 4b05fde873
commit d3f12340e1
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299

View file

@ -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. > 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.
<details>
<summary><strong>Without flakes</strong></summary>
NixVim now ships with `flake-compat`, which makes it usable from any system. NixVim now ships with `flake-compat`, which makes it usable from any system.
To install it, edit your home-manager (or NixOS) configuration: To install it, edit your home-manager (or NixOS) configuration:
@ -76,7 +80,11 @@ in
} }
``` ```
### Using flakes </details>
<details>
<summary><strong>Using flakes</strong></summary>
This is the recommended method if you are already using flakes to manage your 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` 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, for a home-manager installation, `inputs.nixvim.nixosModules.nixvim`, for NixOS,
and `inputs.nixvim.nixDarwinModules.nixvim` for nix-darwin. and `inputs.nixvim.nixDarwinModules.nixvim` for nix-darwin.
</details>
## Usage ## Usage
NixVim can be used in four ways: through the home-manager, nix-darwin, NixOS modules, 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 and standalone through the `makeNixvim` function. To use the modules, just import the