diff --git a/home/base/README.md b/home/base/README.md index 23212104..20f06aec 100644 --- a/home/base/README.md +++ b/home/base/README.md @@ -1,6 +1,5 @@ # Home Manager's Base Submodules -2. `server`: Configuration which is suitable for both servers and desktops. +1. `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 index 8e1e4b45..116e1749 100644 --- a/home/darwin/README.md +++ b/home/darwin/README.md @@ -1,7 +1,6 @@ # 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 index 6227780c..4f73767b 100644 --- a/home/linux/README.md +++ b/home/linux/README.md @@ -2,22 +2,7 @@ 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. - - -## Why install I3/Hyprland in Home Manager instead of a NixOS Module? - -1. I3 & Hyprland's configuration file is located in `~/.config`, which can be easily managed by Home Manager. -2. There're other user-specific systemd servcies, such gammastep, wallpaper-switcher, etc. which can be easily managed by Home Manager, but if we start i3/hyprland in NixOS Module, they may failed to start automatically. With i3/hyprland installed via home-manager, we can control their systemd service's dependent order, to avoid issues like this. -3. By install as less as possible in NixOS Module, we can: - 1. Make the NixOS system more secure and stable. - 2. Make this flake more portable to other non-NixOS systems, as home-manager can be installed on any Linux system. - +7. `desktop.nix`: the entrypoint of desktop's configuration, it import both `base` and `desktop` as its submodules. + 1. used by all my nixos desktops. diff --git a/home/linux/desktop/README.md b/home/linux/desktop/README.md new file mode 100644 index 00000000..dedc1d31 --- /dev/null +++ b/home/linux/desktop/README.md @@ -0,0 +1,16 @@ +# Desktop Related + + +3. `base`: all common configurations for all desktops. +4. `hyprland`: Hyprland's configuration. +5. `i3`: i3's configuration. + + +## Why install I3/Hyprland in Home Manager instead of a NixOS Module? + +1. I3 & Hyprland's configuration file is located in `~/.config`, which can be easily managed by Home Manager. +2. There're other user-specific systemd servcies, such gammastep, wallpaper-switcher, etc. which can be easily managed by Home Manager, but if we start i3/hyprland in NixOS Module, they may failed to start automatically. With i3/hyprland installed via home-manager, we can control their systemd service's dependent order, to avoid issues like this. +3. By install as less as possible in NixOS Module, we can: + 1. Make the NixOS system more secure and stable. + 2. Make this flake more portable to other non-NixOS systems, as home-manager can be installed on any Linux system. + diff --git a/hosts/12kingdoms/shoukei/README.md b/hosts/12kingdoms/shoukei/README.md new file mode 100644 index 00000000..e0b9c67f --- /dev/null +++ b/hosts/12kingdoms/shoukei/README.md @@ -0,0 +1,19 @@ +# Host - Shoukei + +This is NixOS's configuration for my Macbook Pro 2022 Intel i5, 13.3-inch, 16G RAM + 512G SSD. + +Related: + +- [/nixos-installer/README.shoukei.md](/nixos-installer/README.shoukei.md) +- +- + + +TODOs: + +- [ ] Resume from suspend(close the lid) doesn't work +- [ ] Show battery percentage in i3blocks/waybar +- [ ] Touchbar unusable some times + - It works on boot, but after a while it stops working + + diff --git a/hosts/README.md b/hosts/README.md index 3e51cfd4..f26df53a 100644 --- a/hosts/README.md +++ b/hosts/README.md @@ -13,7 +13,7 @@ 2. `yukina`: Lichee Pi 4A(Internal Test Version), TH1520(4xC910@2.0G), 8GB RAM + 8G eMMC + 128G SD Card. 3. `chiaya`: Milk-V Mars, JH7110(4xU74@1.5 GHz), 4G RAM + No eMMC + 64G SD Card. 4. `12kingdoms`: - 1. `shoukei`: NixOS + 1. `shoukei`: NixOS on Macbook Pro 2022 Intel i5, 13.3-inch, 16G RAM + 512G SSD. 1. `suzu`: Orange Pi 5, RK3588s(4xA76 + 4xA55), GPU(4Cores, Mail-G610), NPU(6Tops@int8), 8G RAM + 256G SSD. diff --git a/hosts/idols/ai/README.md b/hosts/idols/ai/README.md index ddb1eae6..feb3eb5a 100644 --- a/hosts/idols/ai/README.md +++ b/hosts/idols/ai/README.md @@ -1,5 +1,11 @@ # Host - AI +Related: + +- [/nixos-installer/README.shoukei.md](/nixos-installer/README.ai.md) + +## Info + disk status & mountpoints: ```bash diff --git a/lib/README.md b/lib/README.md index de340e00..2df1902a 100644 --- a/lib/README.md +++ b/lib/README.md @@ -2,7 +2,8 @@ Some helper functions, used by `flake.nix` to reduce code duplication and make it easier to add new machines: +1. `attrs.nix`: A set of functions to manupulate attribute sets. 1. `macosSystem.nix`: A function to generate config(attribute set) for macOS([nix-darwin](https://github.com/LnL7/nix-darwin)). -2. `nixosSystem.nix`: A function to generate config(attribute set) for NixOS. -3. `colmenaSystem.nix`: A function that generate config(another function) for remote deployment using [colmena](https://github.com/zhaofengli/colmena). - +1. `nixosSystem.nix`: A function to generate config(attribute set) for NixOS. +1. `colmenaSystem.nix`: A function that generate config(another function) for remote deployment using [colmena](https://github.com/zhaofengli/colmena). +1. `default.nix`: import all the above functions, and some custom useful functions, and export them as a single attribute set. diff --git a/modules/README.md b/modules/README.md index d3026703..e00a13c2 100644 --- a/modules/README.md +++ b/modules/README.md @@ -2,4 +2,5 @@ 1. `darwin`: macOS-specific configuration. 2. `nixos`: NixOS-specific configuration. +3. `base.nix`: Common configuration for both NixOS and Nix-Darwin. diff --git a/nixos-installer/README.ai.md b/nixos-installer/README.ai.md index 2dffc19b..f203c7db 100644 --- a/nixos-installer/README.ai.md +++ b/nixos-installer/README.ai.md @@ -1,4 +1,4 @@ -# Nix Environment for Deploying my NixOS Configuration +# Nix Environment Setup for Host: Idols - Ai This flake prepares a Nix environment for setting my desktop [/hosts/idols/ai](/hosts/idols/ai/)(on main flake) up on a new machine. diff --git a/nixos-installer/README.shoukei.md b/nixos-installer/README.shoukei.md index e66a9f1b..7da3954b 100755 --- a/nixos-installer/README.shoukei.md +++ b/nixos-installer/README.shoukei.md @@ -1,4 +1,4 @@ -# Nix Environment for Deploying my NixOS Configuration +# Nix Environment Setup for Host: Shoukei > https://wiki.t2linux.org/distributions/nixos/installation/