dotfiles

commit f7bf03c6a1cd2a9b7f417f5719db3c16250b64c0
parent fb76b086e0d6b544d9f8caccfbd96ff6353a1323
Author: maydayv7 <maydayv7@gmail.com>
Date:   Mon,  4 Dec 2023 14:11:27 +0530

docs: Add README for hardware

Diffstat:

2 files changed, 23 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
@@ -304,29 +304,15 @@ _May change according to available hardware_
 - UEFI Compatible System
 - Intel CPU + iGPU
 
-### Branches
-
-There are two branches, [`stable`](../../tree/stable) and [`develop`](../../tree/develop) (when required). The `stable` branch consists of configuration that builds without failure, and the `develop` branch is a bleeding-edge testbed
+See [this](./modules/hardware/README.md) for additional hardware information
 
 ### Build
 
 While rebuilding system with Flakes, make sure that any file with unstaged changes will not be included. Use `git add .` in cases where the `git` tree is dirty
 
-#### Boot
-
-To boot into a different build generation, hold down the Spacebar (for `efi`) or the `Shift`/`Esc` key (for `mbr`) upon startup to access the boot menu
-
-<details>
-<summary>Secure Boot</summary>
-
-To configure Secure Boot, first install the system by using the `efi` loader, then follow [these](https://github.com/nix-community/lanzaboote/blob/v0.3.0/docs/QUICK_START.md) instructions and set `hardware.boot.loader` to `secure`
+#### Branches
 
-_If the `advanced` filesystem scheme is used, the keys need to be created after `/etc/secureboot` is persisted_
-
-> **Note:**
-> Secure Boot is only supported in EFI Mode
-
-</details>
+There are two branches, [`stable`](../../tree/stable) and [`develop`](../../tree/develop) (when required). The `stable` branch consists of configuration that builds without failure, and the `develop` branch is a bleeding-edge testbed
 
 #### Cache
 
@@ -341,14 +327,6 @@ This repository makes use of [`GitHub Actions`](./.github/workflows) in order to
 - [`ACCESS_TOKEN`](./modules/apps/git/secrets/gitlab-token.secret): Personal Access Token (To create one - [GitHub](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token), [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html))
 - [`CACHIX_TOKEN`](./secrets/cachix-token.secret): Cachix Authentication Token
 
-### File System
-
-The system may be set up using either a `simple` or `advanced` filesystem layout. The advanced ZFS encrypted opt-in state filesystem configuration allows for a vastly improved experience, preventing formation of cruft and exerting total control over the device state, by erasing the system at every boot, keeping only what's required
-
-#### Data Storage
-
-All important, persisted user files are stored at `/data`, while persisted system files are stored at `/nix/state`. Personal files and media are stored at `/data/files`
-
 ### Home Manager
 
 The [`home-manager`](https://github.com/nix-community/home-manager) module is used in tandem with the system configuration in order to define user-specific configuration. The `config.user.home` option has been declared in [`modules/user/default.nix`](./modules/user/default.nix) independent of the original module, from which the final configuration is built, in order to prevent infinite recursion while configuring multiple users per system. The system `config` can be accessed using the `sys` parameter in `home-manager` modules
diff --git a/modules/hardware/README.md b/modules/hardware/README.md
@@ -0,0 +1,20 @@
+### Boot
+
+To boot into a different build generation, hold down the Spacebar (for `efi`) or the `Shift`/`Esc` key (for `mbr`) upon startup to access the boot menu
+
+#### Secure Boot
+
+To configure Secure Boot, first install the system by using the `efi` loader, then follow [these](https://github.com/nix-community/lanzaboote/blob/v0.3.0/docs/QUICK_START.md) instructions and set `hardware.boot.loader` to `secure`
+
+_If the `advanced` filesystem scheme is used, the keys need to be created after `/etc/secureboot` is persisted_
+
+> **Note:**
+> Secure Boot is only supported in EFI Mode
+
+### File System
+
+The system may be set up using either a `simple` or `advanced` filesystem layout. The advanced ZFS encrypted opt-in state filesystem configuration allows for a vastly improved experience, preventing formation of cruft and exerting total control over the device state, by erasing the system at every boot, keeping only what's required
+
+#### Data Storage
+
+All important, persisted user files are stored at `/data`, while persisted system files are stored at `/nix/state`. Personal files and media are stored at `/data/files`