-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): expand to include usage with or without home-manager
- Loading branch information
Showing
1 changed file
with
45 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,54 @@ | ||
# Pyxels Neovim | ||
|
||
This is my personal Neovim config using [Nixvim](https://github.com/nix-community/nixvim). | ||
Neovim config using [Nixvim](https://github.com/nix-community/nixvim). | ||
Compared to my [previous lua config](https://github.com/Pyxels/nvim-config) this is a lot more simple with some seldom used features and overcomplicated configs missing (and it has grown to be a bit different over time). | ||
|
||
> [!NOTE] | ||
> This is my personal config tailored to my specific needs, but can be used as reference or as inspiration for your own config. | ||
## Try it out | ||
To try out this config just run: | ||
|
||
```nix | ||
nix run github:pyxels/nixvim-config | ||
``` | ||
|
||
If you want to run this config just run: | ||
## Usage | ||
Add this repo to you your inputs: | ||
|
||
```nix | ||
inputs = { | ||
nixvim-config.url = "github:pyxels/nixvim-config"; | ||
}; | ||
``` | ||
nix run github:pyxels/nixvim-config | ||
|
||
### Standalone | ||
You can access the nvim + config package itself and add them to your packages. | ||
|
||
```nix | ||
# home-manager | ||
home.packages = [ | ||
inputs.nixvim-config.packages.${system}.default | ||
]; | ||
``` | ||
```nix | ||
# nixos | ||
environment.systemPackages = [ | ||
inputs.nixvim-config.packages.${system}.default | ||
]; | ||
``` | ||
|
||
### Home-Manager module | ||
This flake also exposes a simple home manger module to enable the config and set shell aliases. | ||
|
||
```nix | ||
imports = [ | ||
inputs.nixvim-config.homeModules.default | ||
]; | ||
nixvim-config = { | ||
enable = true; | ||
aliases = ["v" "vim"]; | ||
}; | ||
``` |