docs: update README to match current structure

- Add README.md paths in directory tree (hosts/, profiles/, home/)
- Add category descriptions to profiles
- Mark nixos-lxc as s0.sermc.net
- Add note about per-host README.md
This commit is contained in:
luochen570
2026-05-26 12:42:42 +08:00
parent 33c7f0b6fd
commit e6f99590c5

View File

@@ -9,25 +9,26 @@ nixos/
├── flake.nix # Flake 入口 ├── flake.nix # Flake 入口
├── lib/ ├── lib/
│ ├── mkHost.nix # 主机生成函数 │ ├── mkHost.nix # 主机生成函数
│ └── hosts.nix # 主机定义5 台机器) │ └── hosts.nix # 主机定义
├── profiles/ # 角色配置组合 ├── profiles/ # 角色配置组合
│ ├── desktop.nix │ ├── README.md
│ ├── server.nix │ ├── desktop.nix # 桌面机
│ ├── wsl.nix │ ├── server.nix # 服务器
│ ├── virtualbox.nix │ ├── wsl.nix # WSL (Debian/Windows)
── lxc.nix ── virtualbox.nix # VirtualBox 虚拟机
├── modules/ │ └── lxc.nix # Proxmox LXC 容器
│ ├── core/ # 所有机器共享的基础配置 ├── modules/ # 模块化配置
│ ├── core/ # 所有机器共享的基础配置
│ │ ├── default.nix │ │ ├── default.nix
│ │ ├── core.nix # Nix 设置、时区、语言、GC │ │ ├── core.nix # Nix 设置、时区、语言、GC
│ │ ├── pkg.nix # 基础系统包 │ │ ├── pkg.nix # 基础系统包
│ │ ├── users.nix # 用户与 Shell │ │ ├── users.nix # 用户与 Shell
│ │ └── sops.nix # 密钥管理 │ │ └── sops.nix # 密钥管理
│ ├── server/ # 服务器模块 │ ├── server/ # 服务器模块
│ │ ├── default.nix │ │ ├── default.nix
│ │ ├── docker.nix │ │ ├── docker.nix
│ │ └── ssh.nix │ │ └── ssh.nix
│ ├── desktop/ # 桌面模块 │ ├── desktop/ # 桌面模块
│ │ ├── default.nix │ │ ├── default.nix
│ │ ├── pkg.nix # 桌面应用包 │ │ ├── pkg.nix # 桌面应用包
│ │ ├── apps.nix # MIME 与默认应用 │ │ ├── apps.nix # MIME 与默认应用
@@ -35,23 +36,25 @@ nixos/
│ │ └── de/ │ │ └── de/
│ │ ├── default.nix │ │ ├── default.nix
│ │ └── kde.nix # KDE Plasma 6 + SDDM │ │ └── kde.nix # KDE Plasma 6 + SDDM
── drivers/ ── drivers/
├── nvidia.nix # NVIDIA 独显 ├── nvidia.nix # NVIDIA 独显
└── amdgpu.nix # AMD 核显RDNA2 └── amdgpu.nix # AMD 核显RDNA2
├── home/ # home-manager 用户配置 ├── home/ # home-manager 用户配置
│ ├── README.md
│ ├── default.nix │ ├── default.nix
│ ├── pkg.nix # 用户级包 │ ├── pkg.nix # 用户级包
│ ├── git.nix │ ├── git.nix
│ ├── ssh.nix # SSH 密钥sops 挂载) │ ├── ssh.nix # SSH 密钥sops 挂载)
│ ├── zsh.nix # ZSH + Powerlevel10k │ ├── zsh.nix # ZSH + Powerlevel10k
│ └── nvchad.nix # Neovim (NvChad) │ └── nvchad.nix # Neovim (NvChad)
├── hosts/ # 主机专属配置 ├── hosts/ # 主机专属配置
│ ├── desktop/ # 桌面机AMD + NVIDIA │ ├── README.md
│ ├── server/ # 服务器 │ ├── desktop/ # 桌面机AMD + NVIDIA
│ ├── wsl/ # WSL (NixOS-WSL) │ ├── server/ # 服务器
│ ├── virtualbox/ # VirtualBox 虚拟机 │ ├── wsl/ # WSL (NixOS-WSL)
── nixos-lxc/ # Proxmox LXC 容器 ── virtualbox/ # VirtualBox 虚拟机
└── secrets/ # sops-nix 加密密钥(不公开) │ └── nixos-lxc/ # Proxmox LXC 容器 (s0.sermc.net)
└── secrets/ # sops-nix 加密密钥(不公开)
└── users/luochen570.enc.yaml └── users/luochen570.enc.yaml
``` ```
@@ -63,7 +66,7 @@ nixos/
| `server` | server | x86_64-linux | 服务器 | | `server` | server | x86_64-linux | 服务器 |
| `nixos-wsl` | wsl | x86_64-linux | WSL | | `nixos-wsl` | wsl | x86_64-linux | WSL |
| `virtualbox` | virtualbox | x86_64-linux | VirtualBox 虚拟机 | | `virtualbox` | virtualbox | x86_64-linux | VirtualBox 虚拟机 |
| `nixos-lxc` | lxc | x86_64-linux | Proxmox LXC 容器 | | `nixos-lxc` | lxc | x86_64-linux | Proxmox LXC 容器 (s0.sermc.net) |
## 使用 ## 使用
@@ -102,3 +105,4 @@ sudo nix-collect-garbage --delete-older-than 14d
- NVIDIA 模块的 PRIME双显卡切换方案已注释启用前需通过 `lspci` 确认 PCIe Bus ID - NVIDIA 模块的 PRIME双显卡切换方案已注释启用前需通过 `lspci` 确认 PCIe Bus ID
- LXC 容器使用 Proxmox LXC 模块,关闭了 systemd 挂载报错的服务 - LXC 容器使用 Proxmox LXC 模块,关闭了 systemd 挂载报错的服务
- `secrets/` 目录经过 sops 加密,需有对应 age key 才能解密 - `secrets/` 目录经过 sops 加密,需有对应 age key 才能解密
- 各主机目录下有各自的 `README.md`,含该主机的硬件信息与应用列表