From 691f009656bee5c34d5222f4648711654026c634 Mon Sep 17 00:00:00 2001
From: Colin <colin@uninsane.org>
Date: Mon, 25 Sep 2023 13:35:50 +0000
Subject: [PATCH] clean up documentation

---
 README.md | 34 +++++++++++++++++++++++-----------
 flake.nix |  3 +++
 2 files changed, 26 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 824c8f1e..45688141 100644
--- a/README.md
+++ b/README.md
@@ -4,17 +4,35 @@ this is the top-level repo from which i configure/deploy all my NixOS machines:
 - desktop
 - laptop
 - server
-- mobile phone
+- mobile phone (Pinephone)
 
-i enjoy a monorepo approach. this repo references [nixpkgs][nixpkgs], a couple 3rd party
-nix modules like [sops][sops], the sources for [uninsane.org][uninsane-org], and that's
-about it. custom derivations and modules (some of which i try to upstream) live
-directly here; even the sources for those packages is often kept here too.
+everything outside of <./hosts/> and <./secrets/> is intended for export, to be importable for use by 3rd parties.
+the only hard dependency for my exported pkgs/modules should be [nixpkgs][nixpkgs].
+building <./hosts/> will require [sops][sops].
+
+you might specifically be interested in these files (elaborated further in #key-points-of-interest):
+- [`sxmo-utils-latest`](./pkgs/additional/sxmo-utils/default.nix)
+  - [example SXMO deployment](./hosts/modules/gui/sxmo/default.nix)
+- [my implementation of impermanence](./modules/persist/default.nix)
+- my way of deploying dotfiles/configuring programs per-user:
+  - <./modules/fs/default.nix>
+  - <./modules/programs.nix>
+  - <./modules/users.nix>
 
 [nixpkgs]: https://github.com/NixOS/nixpkgs
 [sops]: https://github.com/Mic92/sops-nix
 [uninsane-org]: https://uninsane.org
 
+## Using This Repo In Your Own Config
+
+this should be a pretty "standard" flake. just reference it, and import either
+- `nixosModules.sane` (for the modules)
+- `overlays.pkgs` (for the packages)
+
+or follow the instructions [here][NUR] to use it via the Nix User Repositories.
+
+[NUR]: https://nur.nix-community.org/
+
 ## Layout
 - `doc/`
     - instructions for tasks i find myself doing semi-occasionally in this repo.
@@ -90,12 +108,6 @@ them being factored out of my config, message me and we could work to make that
 
 [home-manager]: https://github.com/nix-community/home-manager
 
-## Using This Repo In Your Own Config
-
-this should be a pretty "standard" flake. just reference it, and import either
-- `nixosModules.sane` (for the modules)
-- `overlays.pkgs` (for the packages)
-
 ## Mirrors
 
 this repo exists in a few known locations:
diff --git a/flake.nix b/flake.nix
index 5d980309..8625c092 100644
--- a/flake.nix
+++ b/flake.nix
@@ -48,16 +48,19 @@
 
     mobile-nixos = {
       # <https://github.com/nixos/mobile-nixos>
+      # only used for building disk images, not relevant after deployment
       url = "github:nixos/mobile-nixos";
       flake = false;
     };
     sops-nix = {
       # <https://github.com/Mic92/sops-nix>
+      # used to distribute secrets to my hosts
       url = "github:Mic92/sops-nix";
       # inputs.nixpkgs.follows = "nixpkgs";
       inputs.nixpkgs.follows = "nixpkgs-unpatched";
     };
     uninsane-dot-org = {
+      # provides the package to deploy <https://uninsane.org>, used only when building the servo host
       url = "git+https://git.uninsane.org/colin/uninsane";
       # inputs.nixpkgs.follows = "nixpkgs";
       inputs.nixpkgs.follows = "nixpkgs-unpatched";