From bc290e371bc2926bf7042a9d26b7e4a6ec09c380 Mon Sep 17 00:00:00 2001
From: Ryan Yin <xiaoyin_c@qq.com>
Date: Sat, 29 Jul 2023 22:29:45 +0800
Subject: [PATCH] feat: update README

---
 hosts/README.md       | 33 +++++++++++++++++++++++----------
 hosts/idols/README.md | 17 -----------------
 modules/README.md     |  5 +++++
 overlays/README.md    |  9 +++++++++
 4 files changed, 37 insertions(+), 27 deletions(-)
 delete mode 100644 hosts/idols/README.md
 create mode 100644 modules/README.md
 create mode 100644 overlays/README.md

diff --git a/hosts/README.md b/hosts/README.md
index 84bd1da9..9a79f899 100644
--- a/hosts/README.md
+++ b/hosts/README.md
@@ -1,14 +1,27 @@
 # Hosts
 
+1. `harmonica`: My MacBook Pro 2020 13-inch, for work.
+2. `idols`
+   1. `ai`: My main computer, with NixOS + I5-13600KF + RTX 4090 GPU, for gaming & daily use.
+   2. `aquamarine`: My NixOS virtual machine with R9-5900HX(8C16T), for distributed building & testing.
+   3. `kana`: Yet another NixOS vm on another physical machine with R5-5625U(6C12T).
+   4. `ruby`: Another NixOS vm on another physical machine with R7-5825U(8C16T).
 
-```shell
-› tree hosts
-hosts
-├── harmonica  # my MacBook Pro 2020 13-inch, for work.
-└── idols
-    ├── ai         # my main computer, with NixOS + I5-13600KF + RTX 4090 GPU, for gaming & daily use.
-    ├── aquamarine # my NixOS virtual machine with R9-5900HX(8C16T), for distributed building & testing.
-    ├── kana       # yet another NixOS vm on another physical machine with R5-5625U(6C12T).
-    └── ruby       # another NixOS vm on another physical machine with R7-5825U(8C16T).
-```
+# idols - Oshi no Ko
+
+These four servers are named after the four main characters of the mange/anime Oshi no Ko, they form a NixOS distributed building cluster,
+I usually run the build command on `Ai` and nix will distribute the build to other three machines, which is convenient and fast.
+
+When building some packages for riscv64 or aarch64, I often have no cache available because of various changes under the hood, so I need to build much more packages than usual, which is one of the reasons why the cluster was originally built, and another reason is distributed building is cool!
+
+![](/_img/nix-distributed-building.webp)
+
+![](/_img/nix-distributed-building-log.webp)
+
+## References
+
+![](/_img/idols-famaily.webp)
+![](/_img/idols-ai.webp)
+
+See [Oshi no Ko 【推しの子】 - Wikipedia](https://en.wikipedia.org/wiki/Oshi_no_Ko) for more information.
 
diff --git a/hosts/idols/README.md b/hosts/idols/README.md
deleted file mode 100644
index 569c66dd..00000000
--- a/hosts/idols/README.md
+++ /dev/null
@@ -1,17 +0,0 @@
-# Oshi no Ko
-
-These four servers are named after the four main characters of the mange/anime Oshi no Ko, they form a NixOS distributed building cluster,
-I usually run the build command on `Ai` and nix will distribute the build to other three machines, which is convenient and fast.
-
-When building some packages for riscv64 or aarch64, I often have no cache available because of various changes under the hood, so I need to build much more packages than usual, which is one of the reasons why the cluster was originally built, and another reason is distributed building is cool!
-
-![](/_img/nix-distributed-building.webp)
-
-![](/_img/nix-distributed-building-log.webp)
-
-## References
-
-![](/_img/idols-famaily.webp)
-![](/_img/idols-ai.webp)
-
-See [Oshi no Ko 【推しの子】 - Wikipedia](https://en.wikipedia.org/wiki/Oshi_no_Ko) for more information.
diff --git a/modules/README.md b/modules/README.md
new file mode 100644
index 00000000..d3026703
--- /dev/null
+++ b/modules/README.md
@@ -0,0 +1,5 @@
+# NixOS / Nix-Darwin's Submodules
+
+1. `darwin`: macOS-specific configuration.
+2. `nixos`: NixOS-specific configuration.
+
diff --git a/overlays/README.md b/overlays/README.md
new file mode 100644
index 00000000..dec7ff7d
--- /dev/null
+++ b/overlays/README.md
@@ -0,0 +1,9 @@
+# Overlays
+
+Overlays for both NixOS and Nix-Darwin.
+
+If you don't know much about overlays, it is recommended to learn the function and usage of overlays through [Overlays - NixOS & Flakes Book](https://nixos-and-flakes.thiscute.world/nixpkgs/overlays).
+
+1. `default.nix`: the entrypoint of overlays, it execute and import all overlay files in the current directory with the given args.
+2. `fcitx5`: fcitx5's overlay, add my customized Chinese input method - [小鹤音形输入法](https://flypy.com/)
+