docs: use README as a source for the docs

This commit is contained in:
Matt Sturgeon 2025-01-19 13:56:54 +00:00
parent ab693bb1cd
commit 1654f97a79
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 21 additions and 24 deletions

View file

@ -12,6 +12,8 @@
- [Quick set up tutorial](https://www.youtube.com/watch?v=b641h63lqy0) (by [@Vimjoyer](https://www.youtube.com/@vimjoyer))
- [Nixvim: How to configure Neovim with the power of Nix](https://www.youtube.com/watch?v=GOe0C7Qtypk) (NeovimConf 2023 talk by [@GaetanLepage](https://glepage.com/))
<!-- START DOCS -->
## What is it?
NixVim is a [Neovim](https://neovim.io) distribution built around
[Nix](https://nixos.org) modules. It is distributed as a Nix flake, and
@ -37,6 +39,8 @@ catppuccin as the colorscheme, no extra configuration required!
Check out [this list of real world nixvim configs](https://nix-community.github.io/nixvim/user-guide/config-examples.html)!
<!-- STOP DOCS -->
## How does it work?
When you build the module (probably using home-manager), it will install all
your plugins and generate a lua config for NeoVim with all the options