mirror of
https://github.com/youwen5/neovim-flake.git
synced 2024-11-24 19:03:49 -08:00
chore: format readme
This commit is contained in:
parent
7b6cafd1fc
commit
c5f5e6dd9c
1 changed files with 25 additions and 17 deletions
42
README.md
42
README.md
|
@ -1,30 +1,38 @@
|
||||||
# Neovim Configuration Flake
|
# Neovim Configuration Flake
|
||||||
|
|
||||||
This is the Neovim configuration for all my NixOS and Nix enabled systems (such as with nix-darwin on macOS).
|
This is the Neovim configuration for all my NixOS and Nix enabled systems (such
|
||||||
It aims to be minimal and utilitarian; it forgoes many blingful features like status lines, sidebars, or fancy UI enhancements
|
as with nix-darwin on macOS). It aims to be minimal and utilitarian; it forgoes
|
||||||
in favor of native (neo)Vim, while still having everything useful you'd expect, like LSPs, file explorer (`yazi`), completions,
|
many blingful features like status lines, sidebars, or fancy UI enhancements in
|
||||||
advanced language tools, and QoL enhancements.
|
favor of native (neo)Vim, while still having everything useful you'd expect,
|
||||||
|
like LSPs, file explorer (`yazi`), completions, advanced language tools, and
|
||||||
|
QoL enhancements.
|
||||||
|
|
||||||
It uses the [Nixvim](https://nix-community.github.io/nixvim/) project under the hood to declaratively
|
It uses the [Nixvim](https://nix-community.github.io/nixvim/) project under the
|
||||||
configure Neovim and its plugins, and installs some LSPs and other tools needed by it (like `yazi`, `fd`, etc).
|
hood to declaratively configure Neovim and its plugins, and installs some LSPs
|
||||||
|
and other tools needed by it (like `yazi`, `fd`, etc).
|
||||||
|
|
||||||
It simply outputs a package which provides the binary `nvim`. It can be called just like the regular `nvim` binary, except it bundles
|
It simply outputs a package which provides the binary `nvim`. It can be called
|
||||||
all of my custom configuration and their dependencies with the power of Nix. An entirely self-contained, reproducible, purely functional text editor. Amazing.
|
just like the regular `nvim` binary, except it bundles all of my custom
|
||||||
|
configuration and their dependencies with the power of Nix. An entirely
|
||||||
|
self-contained, reproducible, purely functional text editor. Amazing.
|
||||||
|
|
||||||
Feel free to fork or copy the config to use yourself. It's free in the [public domain](./LICENSE).
|
Feel free to fork or copy the config to use yourself. It's free in the [public
|
||||||
|
domain](./LICENSE).
|
||||||
|
|
||||||
Thanks to [this gist](https://gist.github.com/siph/288b7c6b5f68a1902d28aebc95fde4c5) for showing me how to
|
Thanks to [this
|
||||||
build a Nixvim configuration as a standalone Nix package.
|
gist](https://gist.github.com/siph/288b7c6b5f68a1902d28aebc95fde4c5) for
|
||||||
|
showing me how to build a Nixvim configuration as a standalone Nix package.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
You can test drive my config in just one line (if you have Nix, of course):
|
You can test drive my config in just one line (if you have Nix, of course):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nix run 'github:youwen5/neovim-flake' --extra-experimental-features flakes --extra-experimental-features nix-command
|
nix run 'github:youwen5/neovim-flake' --extra-experimental-features flakes --extra-experimental-features nix-command
|
||||||
```
|
```
|
||||||
|
|
||||||
If for some reason, you want to install it permanently, add it to your flake inputs,
|
If for some reason, you want to install it permanently, add it to your flake
|
||||||
and install the package in the usual way:
|
inputs, and install the package in the usual way:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
# flake.nix
|
# flake.nix
|
||||||
|
@ -54,7 +62,7 @@ and install the package in the usual way:
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> This package will add the symlinks `vim -> nvim` and `vi -> nvim` so it will conflict with
|
> This package will add the symlinks `vim -> nvim` and `vi -> nvim`
|
||||||
> `pkgs.vim` and any programs installing binaries called `vim` or `vi`. You must remove existing
|
> so it will conflict with `pkgs.vim` and any programs installing binaries
|
||||||
> Neovim and Vim packages to install this.
|
> called `vim` or `vi`. You must remove existing Neovim and Vim packages to
|
||||||
|
> install this.
|
||||||
|
|
Loading…
Reference in a new issue