1
0
Fork 0
mirror of https://github.com/NotAShelf/neovim-flake.git synced 2024-12-27 23:09:49 +01:00
neovim-flake/docs/manual/try-it-out.md

46 lines
1.7 KiB
Markdown
Raw Normal View History

2023-12-09 20:03:58 +01:00
# Try it out {#ch-try-it-out}
2023-02-06 19:10:37 +01:00
Thanks to the portability of Nix, you can try out nvf without actually installing it to your machine.
Below are the commands you may run to try out different configurations provided by this flake. As of v0.5, three
configurations are provided:
2023-12-09 20:03:58 +01:00
- Nix
- Tidal
- Maximal
You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed.
2023-12-09 20:03:58 +01:00
```console
$ cachix use nvf # Optional: it'll save you CPU resources and time
$ nix run github:notashelf/nvf#nix # will run the default minimal configuration
2023-12-09 20:03:58 +01:00
```
2023-02-06 19:10:37 +01:00
Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store
2024-04-20 05:57:11 +02:00
once you garbage collect.
2023-12-09 20:03:58 +01:00
## Using Prebuilt Configs {#sec-using-prebuild-configs}
2023-02-06 19:10:37 +01:00
2023-12-09 20:03:58 +01:00
```console
$ nix run github:notashelf/nvf#nix
$ nix run github:notashelf/nvf#tidal
$ nix run github:notashelf/nvf#maximal
2023-12-09 20:03:58 +01:00
```
2023-02-06 19:10:37 +01:00
2023-12-09 20:03:58 +01:00
### Available Configs {#sec-available-configs}
2023-02-06 19:10:37 +01:00
2023-12-09 20:03:58 +01:00
#### Nix {#sec-configs-nix}
2023-02-06 19:10:37 +01:00
`Nix` configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
2024-04-20 05:57:11 +02:00
By running `nix run .#`, which is the default package, you will build Neovim with this config.
2023-02-06 19:10:37 +01:00
2023-12-09 20:03:58 +01:00
#### Tidal {#sec-configs-tidal}
2023-02-06 19:10:37 +01:00
Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.
2023-04-15 11:06:03 +02:00
2023-12-09 20:03:58 +01:00
#### Maximal {#sec-configs-maximal}
2023-02-06 19:10:37 +01:00
`Maximal` is the ultimate configuration that will enable support for more commonly used language as well as additional
complementary plugins. Keep in mind, however, that this will pull a lot of dependencies.
2023-02-06 19:10:37 +01:00
2023-12-09 20:03:58 +01:00
You are _strongly_ recommended to use the binary cache if you would like to try the Maximal configuration.