Merge fbe0d142e4 into aa7b55fa49

.github/README.md

@@ -210,12 +210,16 @@ features.
 
 Alongside myself, nvf is developed by those talented folk:
 
-- [**@horriblename**](https://github.com/horriblename) - For actively
-  implementing planned features and quality of life updates.
+- [**@horriblename**](https://github.com/horriblename)
+  ([Liberapay](https://liberapay.com/horriblename/))- For actively implementing
+  planned features and quality of life updates.
 - [**@Diniamo**](https://github.com/Diniamo)
   ([Liberapay](https://en.liberapay.com/diniamo/)) - For actively submitting
   pull requests, issues and assistance with maintenance of nvf.
 
+Please do remember to extend your thanks (financially or otherwise) if this
+project has been helpful to you.
+
 ### Contributors
 
 [mnw]: https://github.com/gerg-l/mnw
@@ -245,17 +249,17 @@ This configuration borrows from and is based on a few other configurations,
 including:
 
 - [@jordanisaacs's](https://github.com/jordanisaacs)
-  [neovim-flake](https://github.com/jordanisaacs/neovim-flake) that this flake
-  is originally based on.
-- [@sioodmy's](https://github.com/sioodmy)
-  [dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design
-  choices for UI and plugin defaults.
+  [**neovim-flake**](https://github.com/jordanisaacs/neovim-flake) that this
+  flake is originally based on.
 - [@wiltaylor's](https://github.com/wiltaylor)
   [neovim-flake](https://github.com/wiltaylor/neovim-flake) for plugin and
   design ideas.
 - [@gvolpe's](https://github.com/gvolpe)
   [neovim-flake](https://github.com/gvolpe/neovim-flake) for plugin, design and
   nix concepts.
+- [@sioodmy's](https://github.com/sioodmy)
+  [dotfiles](https://github.com/sioodmy/dotfiles) that inspired the design
+  choices for UI and plugin defaults.
 
 I am grateful for their previous work and inspiration, and I wholeheartedly
 recommend checking their work out.
@@ -263,12 +267,12 @@ recommend checking their work out.
 
 ## License
 
-Following the license of the
-[original neovim-flake](https://github.com/jordanisaacs/neovim-flake), nvf has
-been made available under the [**MIT License**](LICENSE). However, all assets
-and documentation are published under the
+Following the license of
+[the original neovim-flake](https://github.com/jordanisaacs/neovim-flake), nvf
+has been made available under the [**MIT License**](LICENSE). However, all
+assets and documentation are published under the
 [**CC BY License**](https://github.com/NotAShelf/nvf/blob/main/.github/assets/LICENSE)
-under explicit permission by the artist.
+under explicit permission by the author or authors.
 
 <h6 align="center">Yes, this includes the logo work too. Stop taking artwork that is not yours!</h6>
 

docs/manual/installation/modules/home-manager.md

@@ -10,12 +10,18 @@ To use it, we first add the input flake.
 ```nix
 {
   inputs = {
+    # Optional, if you intend to follow nvf's obsidian-nvim input
+    # you must also add it as a flake input.
     obsidian-nvim.url = "github:epwalsh/obsidian.nvim";
+
+    # Required, nvf works best and only directly supports flakes
     nvf = {
       url = "github:notashelf/nvf";
-      # you can override input nixpkgs
+      # You can override the input nixpkgs to follow your system's
+      # instance of nixpkgs. This is safe to do as nvf does not depend
+      # on a binary cache.
       inputs.nixpkgs.follows = "nixpkgs";
-      # you can also override individual plugins
+      # Optionally, you can also override individual plugins
       # for example:
       inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
     };
@@ -27,8 +33,8 @@ Followed by importing the home-manager module somewhere in your configuration.
 
 ```nix
 {
-  # assuming nvf is in your inputs and inputs is in the argset
-  # see example below
+  # Assuming "nvf" is in your inputs and inputs is in the argument set.
+  # See example installation below
   imports = [ inputs.nvf.homeManagerModules.default ];
 }
 ```

docs/manual/installation/modules/nixos.md

@@ -10,12 +10,18 @@ To use it, we first add the input flake.
 ```nix
 {
   inputs = {
+    # Optional, if you intend to follow nvf's obsidian-nvim input
+    # you must also add it as a flake input.
     obsidian-nvim.url = "github:epwalsh/obsidian.nvim";
+
+    # Required, nvf works best and only directly supports flakes
     nvf = {
       url = "github:notashelf/nvf";
-      # you can override input nixpkgs
+      # You can override the input nixpkgs to follow your system's
+      # instance of nixpkgs. This is safe to do as nvf does not depend
+      # on a binary cache.
       inputs.nixpkgs.follows = "nixpkgs";
-      # you can also override individual plugins
+      # Optionally, you can also override individual plugins
       # for example:
       inputs.obsidian-nvim.follows = "obsidian-nvim"; # <- this will use the obsidian-nvim from your inputs
     };