diff --git a/README.md b/README.md index c0f1288b..1a50ce24 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Check out [this list of real world Nixvim configs](https://nix-community.github. ## How does it work? -When you build the module (probably using home-manager), it will install all +When you build the module (probably using Home Manager), it will install all your plugins and generate a lua config for Neovim with all the options specified. Because it uses lua, this ensures that your configuration will load as fast as possible. @@ -100,7 +100,7 @@ For more detail, see the [Installation](https://nix-community.github.io/nixvim) Nixvim now ships with `flake-compat`, which makes it usable from any system. -To install it, edit your home-manager (or NixOS) configuration: +To install it, edit your Home Manager, NixOS or nix-darwin configuration: ```nix { pkgs, lib, ... }: @@ -113,7 +113,7 @@ let in { imports = [ - # For home-manager + # For Home Manager nixvim.homeModules.nixvim # For NixOS nixvim.nixosModules.nixvim @@ -159,13 +159,13 @@ flakes, just add the `nixvim` input: ``` You can now access the module using `inputs.nixvim.homeModules.nixvim`, -for a home-manager installation, `inputs.nixvim.nixosModules.nixvim`, for NixOS, +for a Home Manager installation, `inputs.nixvim.nixosModules.nixvim`, for NixOS, and `inputs.nixvim.nixDarwinModules.nixvim` for nix-darwin. ## Usage -Nixvim can be used in four ways: through the home-manager, nix-darwin, NixOS modules, +Nixvim can be used in four ways: through the Home Manager, nix-darwin, NixOS modules, and standalone through the `makeNixvim` function. To use the modules, just import the `nixvim.homeModules.nixvim`, `nixvim.nixDarwinModules.nixvim`, and `nixvim.nixosModules.nixvim` modules, depending on which system diff --git a/docs/lib/index.md b/docs/lib/index.md index 3f96f923..f974029d 100644 --- a/docs/lib/index.md +++ b/docs/lib/index.md @@ -10,7 +10,7 @@ If Nixvim is built using the standalone method, you can access our "helpers" as } ``` -If Nixvim is being used as as a home-manager module, a nixos module, or as a darwin module, our "helpers" can be accessed via the `config.lib` option: +If Nixvim is being used as as a Home Manager module, a NixOS module, or as a nix-darwin module, our "helpers" can be accessed via the `config.lib` option: ```nix { config, ... }: diff --git a/docs/man/nixvim-header-start.5 b/docs/man/nixvim-header-start.5 index c95aac78..1000d0d6 100644 --- a/docs/man/nixvim-header-start.5 +++ b/docs/man/nixvim-header-start.5 @@ -9,4 +9,4 @@ NixVim options specification .SH "DESCRIPTION" .PP -This page lists all the options that can be used in NixVim. It can either be used as a Home-Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. +This page lists all the options that can be used in NixVim. It can either be used as a Home Manager module, an NixOS module or a standalone package. Please refer to the installation instructions for more details. diff --git a/docs/platforms/index.md b/docs/platforms/index.md index dcc5c7cc..9ee232f6 100644 --- a/docs/platforms/index.md +++ b/docs/platforms/index.md @@ -1,7 +1,7 @@ # Platform-specific options All of Nixvim's options are available within `programs.nixvim.*` when Nixvim is used via wrapper modules, -such as our NixOS, home-manager, or nix-darwin modules. +such as our NixOS, Home Manager, or nix-darwin modules. When Nixvim is used standalone (without a wrapper module), its options are available at the "top-level". See [Standalone Usage](./standalone.md) for more info. diff --git a/docs/platforms/standalone.md b/docs/platforms/standalone.md index a75f8523..3721ca41 100644 --- a/docs/platforms/standalone.md +++ b/docs/platforms/standalone.md @@ -9,7 +9,7 @@ There are **no** standalone-specific options available. ## Using in another configuration -Here is an example on how to integrate into a NixOS or Home-manager configuration when using flakes. +Here is an example on how to integrate into a NixOS or Home Manager configuration when using flakes. The example assumes your standalone config is the `default` package of a flake, and you've named the input "`nixvim-config`". ```nix @@ -17,7 +17,7 @@ The example assumes your standalone config is the `default` package of a flake, { # NixOS environment.systemPackages = [ inputs.nixvim-config.packages.${system}.default ]; - # home-manager + # Home Manager home.packages = [ inputs.nixvim-config.packages.${system}.default ]; } ``` @@ -53,7 +53,7 @@ This will generate a `init.lua` that will contain the comments from each stages: The `config` used to produce a standalone nixvim derivation can be accessed as an attribute on the derivation, similar to `.extend`. -This may be useful if you want unrelated parts of your NixOS or home-manager configuration to use the same value as something in your nixvim configuration. +This may be useful if you want unrelated parts of your NixOS, Home Manager or nix-darwin configuration to use the same value as something in your nixvim configuration. ## Accessing nixvim options diff --git a/docs/user-guide/faq.md b/docs/user-guide/faq.md index c94eb7aa..73d9557e 100644 --- a/docs/user-guide/faq.md +++ b/docs/user-guide/faq.md @@ -90,7 +90,7 @@ This usually means one of two things: When building nixvim using flakes and our ["standalone mode"][standalone], we usually recommend _not_ declaring a "follows" for `inputs.nixvim`. This is so that nixvim is built against the same nixpkgs revision we're using in our test suite. -If you are building nixvim using the NixOS, home-manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours. +If you are building nixvim using the NixOS, Home Manager, or nix-darwin modules then we advise that you keep your nixpkgs lock as close as possible to ours. > [!TIP] > Once [#1784](https://github.com/nix-community/nixvim/issues/1784) is implemented, there will be alternative ways to achieve this using the module system. diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md index 0fbdd6d8..5a373292 100644 --- a/docs/user-guide/install.md +++ b/docs/user-guide/install.md @@ -11,7 +11,7 @@ Failure to use the correct branch, or an old revision of nixpkgs will likely res NixVim can be used in four ways: - As a NixOS module -- As a Home-Manager module +- As a Home Manager module - As a nix-darwin module - As a standalone derivation @@ -45,14 +45,14 @@ When using flakes you can simply add `nixvim` to the inputs: ## Usage -NixVim can be used standalone or as a module for NixOS, home-manager, or nix-darwin. +NixVim can be used standalone or as a module for NixOS, Home Manager, or nix-darwin. When used standalone, a custom NixVim derivation is produced that can be used like any other package. When used as a module, NixVim can be enabled though `programs.nixvim.enable`. -### Usage as a module (NixOS, home-manager, nix-darwin) +### 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. The three imports are: @@ -92,7 +92,7 @@ options as `programs.nixvim...