2023-12-09 19:03:58 +00:00
|
|
|
# Try it out {#ch-try-it-out}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-10-03 19:06:26 +00:00
|
|
|
Thanks to the portability of Nix, you can try out neovim-flake 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 19:03:58 +00:00
|
|
|
- Nix
|
|
|
|
- Tidal
|
|
|
|
- Maximal
|
2023-10-03 19:06:26 +00:00
|
|
|
|
|
|
|
You may try out any of the provided configurations using the `nix run` command on a system where Nix is installed.
|
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
```console
|
2023-02-06 18:10:37 +00:00
|
|
|
$ cachix use neovim-flake # Optional: it'll save you CPU resources and time
|
2023-10-03 19:06:26 +00:00
|
|
|
$ nix run github:notashelf/neovim-flake#nix # will run the default minimal configuration
|
2023-12-09 19:03:58 +00:00
|
|
|
```
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-10-03 19:06:26 +00:00
|
|
|
Do keep in mind that this is **susceptible to garbage collection** meaning it will be removed from your Nix store
|
2024-04-20 03:57:11 +00:00
|
|
|
once you garbage collect.
|
2023-10-03 19:06:26 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
## Using Prebuilt Configs {#sec-using-prebuild-configs}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
```console
|
2023-10-03 19:06:26 +00:00
|
|
|
$ nix run github:notashelf/neovim-flake#nix
|
|
|
|
$ nix run github:notashelf/neovim-flake#tidal
|
|
|
|
$ nix run github:notashelf/neovim-flake#maximal
|
2023-12-09 19:03:58 +00:00
|
|
|
```
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
### Available Configs {#sec-available-configs}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
#### Nix {#sec-configs-nix}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-10-03 19:06:26 +00:00
|
|
|
`Nix` configuration by default provides LSP/diagnostic support for Nix alongisde a set of visual and functional plugins.
|
2024-04-20 03:57:11 +00:00
|
|
|
By running `nix run .#`, which is the default package, you will build Neovim with this config.
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
#### Tidal {#sec-configs-tidal}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-10-03 19:06:26 +00:00
|
|
|
Tidal is an alternative config that adds vim-tidal on top of the plugins from the Nix configuration.
|
2023-04-15 09:06:03 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
#### Maximal {#sec-configs-maximal}
|
2023-02-06 18:10:37 +00:00
|
|
|
|
2023-10-03 19:06:26 +00: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 18:10:37 +00:00
|
|
|
|
2023-12-09 19:03:58 +00:00
|
|
|
You are _strongly_ recommended to use the binary cache if you would like to try the Maximal configuration.
|