Skip to content

Commit

Permalink
doc: explain how to use the module in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Shyrogan committed Oct 25, 2024
1 parent 1931bc4 commit cd65df8
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,17 +60,33 @@ However if you'd like to give it a try before installing, <b>nix run github:redy
<summary><b>INSTALLATION GUIDE</b></summary>
I'm assuming you already use nix flakes but in case you don't, please check this tutorial to enable them:

[Flakes](https://nixos.wiki/wiki/Flakes)
1. Go to flake.nix and add Neve.url = "github:redyf/Neve" to your inputs.

After enabling it, follow the steps below:
2. Run nix flake update, then Neve should be available for installation.

### Option 1: Using [Flakes](https://nixos.wiki/wiki/Flakes) to install Neve as a Nixvim module.

1- Go to flake.nix and add Neve.url = "github:redyf/Neve" to your inputs.
3. Install it by adding the following code to Nixvim configuration:

2- Run nix flake update, then Neve should be available for installation.
```nix
programs.nixvim = {
enable = true;
imports = [ inputs.Neve.nixvimModule ];
# Then configure Nixvim as usual, you might have to lib.mkForce some of the settings
colorschemes.catppuccin.enable = lib.mkForce false;
colorschemes.nord.enable = true;
};
```

4. Rebuild your system and you should be done :

### Option 2: Using [Flakes](https://nixos.wiki/wiki/Flakes) to install Neve as a package

After enabling it, follow the steps below:

3- Install it by adding `inputs.Neve.packages.${pkgs.system}.default` to your environment.systemPackages or home.packages if you're using home-manager.
3. Install it by adding `inputs.Neve.packages.${pkgs.system}.default` to your environment.systemPackages or home.packages if you're using home-manager.

4- Rebuild your system and you should be done :
4. Rebuild your system and you should be done :

</details>

Expand Down

0 comments on commit cd65df8

Please sign in to comment.