docs: streamline manpages

This commit is contained in:
NotAShelf 2023-02-06 21:10:37 +03:00
commit 206e17bbe4
No known key found for this signature in database
GPG key ID: 5B5C8895F28445F1
8 changed files with 133 additions and 41 deletions

32
docs/try-it-out.adoc Normal file
View file

@ -0,0 +1,32 @@
[[ch-try-it-out]]
== Try it out
[source,console]
----
$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
$ nix run github:notashelf/neovim-flake
----
=== Nix
By default LSP support for Nix is enabled alongside all complementary Neovim plugins. By running `nix run .`, which is the default package,
you will build Neovim with this config.
=== Tidal
Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.
=== Maximal
Maximal is the ultimate configuration that will enable basically everything. Keep in mind, however, that this will pull a lot of dependencies.
=== Using Prebuilt Configs
[source,console]
----
$ nix run github:notashelf/neovim-flake#nix
$ nix run github:notashelf/neovim-flake#tidal
$ nix run github:notashelf/neovim-flake#maximal
----