From 66396761aae55a2f8ae32c4f81b46e02ce548290 Mon Sep 17 00:00:00 2001 From: Mohammad Rafiq Date: Wed, 2 Jul 2025 19:43:34 +0800 Subject: [PATCH] docs: improve README structure, add headings --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9118fd1..264d47b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# Planning +# Pantheon -## To-do +This repository serves as a flake for storing nixos and nix-darwin configurations. + +## Planning + +### To-do - [ ] Copy over ~/.ssh/id_ed25519 and zellij status bar plugin confirmation - [ ] Migrate immich to apollo, point to helios @@ -9,7 +13,7 @@ - [x] Add forgejo - [ ] Add simple blog -## Versions +### Versions - 1.0.0 - Setup desktop as hypervisor with nixos and win11 @@ -43,8 +47,9 @@ - CI should be set up for updating packages and testing in VMs - Home configurations should work across darwin and nixos - Home configurations should be dotfiles only, and packages should be configured from the system config (tentative) +- Packages should only be installed to the path if they are actively used. One use programs should be used via comma or scripts calling their packages. -# Modules +## Modules The nixosModules and homeModules exposed by this flake are slightly out of the norm. @@ -57,7 +62,7 @@ System configurations, to this end, should include the window manager, lockscree These desktop programs will be **configured** in home-manager for each user, but those configurations consult the osConfig variable passed in by home-manager. -# System Setup +## System Setup The following files are **required** for system activation: @@ -88,7 +93,7 @@ TMPDIR=/mnt/tmp nixos-install --flake github:rrvsh/pantheon# --no-root reboot ``` -# Impermanence +## Impermanence System and user state is stored under /persist. Anything not declared under `{environment,home}.persistence` is deleted on system boot.