mirror of
https://github.com/nix-community/nixvim.git
synced 2025-12-09 18:41:07 +01:00
docs: discourage use of follows
Signed-off-by: saygo-png <saygo.mail@proton.me>
This commit is contained in:
parent
b502802572
commit
b65233d5f9
2 changed files with 6 additions and 9 deletions
|
|
@ -35,13 +35,15 @@ When using flakes you can simply add `nixvim` to the inputs:
|
|||
inputs.nixvim = {
|
||||
url = "github:nix-community/nixvim";
|
||||
# If using a stable channel you can use `url = "github:nix-community/nixvim/nixos-<version>"`
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
|
||||
# outputs...
|
||||
}
|
||||
|
||||
```
|
||||
We recommend against using `inputs.nixpkgs.follows = "nixpkgs";` on the `nixvim` input as we test Nixvim against our Nixpkgs revision.
|
||||
When you use `follows` you opt out of guarantees provided by these tests.
|
||||
If you choose to use it anyway, removing `follows` should be one of the first debugging steps when encountering issues.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -51,7 +53,6 @@ When used standalone, a custom Nixvim derivation is produced that can be used li
|
|||
|
||||
When used as a module, Nixvim can be enabled though `programs.nixvim.enable`.
|
||||
|
||||
|
||||
### Usage as a module (NixOS, Home Manager, nix-darwin)
|
||||
|
||||
When using Nixvim as a module you must import the Nixvim module into your module system.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue