NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-11-10 23:45:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: clean up documentation directory

Browse source
This commit is contained in:
NotAShelf 2023-06-06 03:01:44 +03:00
commit 294b712c15
No known key found for this signature in database
GPG key ID: F0D14CCB5ED5AA22
10 changed files with 100 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

34
docs/manual/try-it-out.adoc Normal file
View file

@ -0,0 +1,34 @@
[[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 # will run the default configuration
----
=== 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.
You are strongly recommended to use the binary cache if you would like to try the Maximal configuration.
=== 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
----