From 1f779aa81a5b866523f91771ae5dce32056f16ce Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Mon, 6 Feb 2023 05:32:13 +0300 Subject: [PATCH] docs: update readme & style --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a3030a5..1a0b8a8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ Repo Size -

@@ -25,24 +24,31 @@ An Nix wrapped IDE layer for the superior text editor, Neovim. --- **[
 Install 
][Install]**  -**[
 Configure 
][Configure]**  -**[
 Documentation 
][Documentation]**  +**[
 Configure 
][Configure]** +**[
 Documentation 
][Documentation]** **[
 Contribute 
][Contribute]** **[
 FAQ 
][Faq]** +[Contribute]: #contributing +[Install]: #install +[Configure]: #configure +[Documentation]: #documentation +[FAQ]: #faq + --- A highly configurable nix flake for Neovim, packing everything you might need to create your own neovim IDE. ## Install -**Using `nix`** +### Using `nix` The easiest way to install is to use the `nix profile` command. To install the default configuration, run: ```console nix run github:notashelf/neovim-flake ``` + The package exposes `.#nix` as the default output. You may use `.#nix`, `.#tidal` or `.#maximal` to get different configurations. It is as simply as changing the target output to get a different configuration. For example, to get a configuration with `tidal` support, run: @@ -53,7 +59,7 @@ nix run github:notashelf/neovim-flake#tidal Similar instructions will apply for `nix profile install`. -**On NixOS** +### On NixOS NixOS users may add this repo to their flake inputs as such: