neovim-flake/README.md

43 lines
2.3 KiB
Markdown
Raw Normal View History

# neovim-flake
2023-02-04 02:16:26 +01:00
A highly configurable nix flake for neovim, packing everything you might need to create your own neovim IDE.
## Documentation
2023-02-03 22:35:00 +01:00
See the [neovim-flake Manual](https://notashelf.github.io/neovim-flake/) for documentation, available options, and release notes.
If you want to dive right into trying neovim-flake you can get a fully featured configuration with `nix` language support by running:
2023-02-03 22:35:00 +01:00
```console
nix run github:notashelf/neovim-flake
```
2023-02-04 02:16:26 +01:00
The documentation is scarce right now as a result of the ongoing rebase and refactor, but shall be available once more soon.
2023-02-03 22:35:00 +01:00
## Help
2023-02-03 22:35:00 +01:00
You can create an issue on the [issue tracker](issues) to ask questions or report bugs. I am not yet on spaces like matrix or IRC, so please use the issue tracker for now.
## Philosophy
2023-02-04 02:16:26 +01:00
The philosophy behind this flake configuration is to create an eaesily configurable and reproducible neovim environment. While it does sacrifice in size
(which I know some users will find *disagreeable*), it offers a lot of flexibiity and configurability in exchange for the large size of the flake inputs.
The KISS (Keep it simple, stupid) principle has been abandoneed here, but you can ultimately declare a configuration that follows KISS.
For it is very easy to bring your own plugins and configurations. Whether you are a developer, writer, or live coder (see tidal cycles below!),
quickly craft a config that suits every project's need. Think of it like a distribution of Neovim that takes advantage of pinning vim plugins and
third party dependencies (such as tree-sitter grammars, language servers, and more).
2023-02-04 02:16:26 +01:00
One should never get a broken config when setting options. If setting multiple options results in a broken neovim, file an issue! Each plugin knows when another plugin which allows for smart configuration of keybindings and automatic setup of things like completion sources and languages.
2023-02-04 02:16:26 +01:00
## Credits
2023-02-03 22:35:00 +01:00
This configuration is based on a few other configurations, including:
- @sioodmy's [dotfiles](https://github.com/sioodmy/dotfiles)
- @wiltaylor's [neovim-flake](https://github.com/wiltaylor/neovim-flake)
- @jordanisaacs's [neovim-flake](https://github.com/jordanisaacs/neovim-flake)
- @gvolpe's [neovim-flake](https://github.com/gvolpe/neovim-flake)
I am grateful for their work and inspiration.
2023-02-04 02:16:26 +01:00
---