From 41794c222a5eaa966e5513c707c0b3f5e7abf5e0 Mon Sep 17 00:00:00 2001
From: seth <getchoo@tuta.io>
Date: Sun, 7 Jul 2024 15:29:11 -0400
Subject: [PATCH] flake: document optional inputs

---
 flake.nix | 34 ++++++++++++++++++++++++++++++----
 1 file changed, 30 insertions(+), 4 deletions(-)

diff --git a/flake.nix b/flake.nix
index d3653c1b..7c13175d 100644
--- a/flake.nix
+++ b/flake.nix
@@ -3,6 +3,36 @@
 
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+
+    flake-parts = {
+      url = "github:hercules-ci/flake-parts";
+      inputs.nixpkgs-lib.follows = "nixpkgs";
+    };
+
+    /*
+      # NOTE: The inputs below this comment are optional
+      # You can remove them with `inputs.<input>.follows = ""`
+
+      For example:
+
+      ```
+      nixvim = {
+        url = "github:nix-community/nixvim";
+        inputs = {
+          nixpkgs.follows = "nixpkgs";
+          flake-parts.follows = "flake-parts";
+
+          devshell.follows = "";
+          flake-compat.follows = "";
+          git-hooks.follows = "";
+          home-manager.follows = "";
+          nix-darwin.follows = "";
+          treefmt-nix.follows = "";
+        };
+      };
+      ```
+    */
+
     home-manager = {
       url = "github:nix-community/home-manager";
       inputs.nixpkgs.follows = "nixpkgs";
@@ -12,10 +42,6 @@
       inputs.nixpkgs.follows = "nixpkgs";
     };
 
-    flake-parts = {
-      url = "github:hercules-ci/flake-parts";
-      inputs.nixpkgs-lib.follows = "nixpkgs";
-    };
     devshell = {
       url = "github:numtide/devshell";
       inputs.nixpkgs.follows = "nixpkgs";