From 1426deb3e65f81d912714650a24ec28673b94ba1 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sat, 4 Feb 2023 04:16:26 +0300 Subject: [PATCH] docs: update readme --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6375f77..ba7228c 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,34 @@ # neovim-flake -A highly configurable nix flake for neovim. +A highly configurable nix flake for neovim, packing everything you might need to create your own neovim IDE. ## Documentation 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: ```console nix run github:notashelf/neovim-flake ``` +The documentation is scarce right now as a result of the ongoing rebase and refactor, but shall be available once more soon. + ## Help 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 -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 flexibility and configurability. It is also very easy to add your own plugins and configuration. 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). +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). -As a result, 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. +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. -## Credit +## Credits This configuration is based on a few other configurations, including: @@ -33,3 +38,5 @@ This configuration is based on a few other configurations, including: - @gvolpe's [neovim-flake](https://github.com/gvolpe/neovim-flake) I am grateful for their work and inspiration. + +---