From b4074538366b05536d4399dd68ecbe86aa2d6809 Mon Sep 17 00:00:00 2001
From: Ryan Yin <xiaoyin_c@qq.com>
Date: Sat, 29 Jul 2023 22:15:01 +0800
Subject: [PATCH] feat: add README into subfolders

---
 home/README.md        |  6 ++++++
 home/base/README.md   |  6 ++++++
 home/darwin/README.md |  7 +++++++
 home/linux/README.md  | 13 +++++++++++++
 secrets/README.md     |  2 +-
 5 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 home/README.md
 create mode 100644 home/base/README.md
 create mode 100644 home/darwin/README.md
 create mode 100644 home/linux/README.md

diff --git a/home/README.md b/home/README.md
new file mode 100644
index 00000000..e10704cf
--- /dev/null
+++ b/home/README.md
@@ -0,0 +1,6 @@
+# Home Manager's Submodules
+
+1. `base`: The base module that is suitable for both Linux and macOS.
+2. `linux`: Linux-specific configuration.
+3. `darwin`: macOS-specific configuration.
+
diff --git a/home/base/README.md b/home/base/README.md
new file mode 100644
index 00000000..23212104
--- /dev/null
+++ b/home/base/README.md
@@ -0,0 +1,6 @@
+# Home Manager's Base Submodules
+
+2. `server`: Configuration which is suitable for both servers and desktops.
+1. `desktop`: Configuration for desktop environments, such as Hyprland, I3, etc.
+    1. it import `server` as its submodule.
+
diff --git a/home/darwin/README.md b/home/darwin/README.md
new file mode 100644
index 00000000..8e1e4b45
--- /dev/null
+++ b/home/darwin/README.md
@@ -0,0 +1,7 @@
+# Home Manager's Darwin Submodules
+
+1. `core.nix`: some basic configuration.
+2. `nushell.nix`: nushell's configuration for darwin.
+3. `rime-squirrel.nix`: [rime-squirrel](https://github.com/rime/squirrel)'s configuration.
+4. `default.nix`: the entrypoint of darwin's configuration, it import all the submodules above.
+
diff --git a/home/linux/README.md b/home/linux/README.md
new file mode 100644
index 00000000..3f8e4b1e
--- /dev/null
+++ b/home/linux/README.md
@@ -0,0 +1,13 @@
+# Home Manager's Linux Submodules
+
+1. `base`: The base module that is suitable for any NixOS environment.
+2. `desktop`: Configuration for desktop environments, such as Hyprland, I3, etc.
+3. `fcitx5`: fcitx5's configuration(Chinese input method).
+4. `hyprland`: Hyprland's configuration.
+5. `i3`: i3's configuration.
+6. `server.nix`: Configuration which is suitable for both servers and desktops. It import only `base` as its submodule.
+    1. used by all my nixos servers.
+6. `desktop-hyprland.nix`: the entrypoint of hyprland's configuration, it import all the submodules above, except `i3`.
+    1. used by my hyprland desktop.
+7. `desktop-i3.nix`: the entrypoint of i3's configuration, it import all the submodules above, except `hyprland`.
+    1. used by my i3 desktop.
diff --git a/secrets/README.md b/secrets/README.md
index 2605bf3c..83b010c3 100644
--- a/secrets/README.md
+++ b/secrets/README.md
@@ -8,7 +8,7 @@ they are decrypted only when they are finally used.
 
 In addition, we further improve the security of secrets files by storing them in a separate private repository.
 
-This directory contains this README.md, and a `default.nix` that used to decrypt all my secrets via agenix, and then I can use them in this flake.
+This directory contains this README.md, and a `nixos.nix`/`darwin.nix` that used to decrypt all my secrets via agenix, and then I can use them in this flake.
 
 ## Adding or Updating Secrets