feat: improve documentation of installed packages

Signed-off-by: wrightbradley <[email protected]>

.gitignore

@@ -61,3 +61,4 @@ prose_styles/Google
 prose_styles/Readability
 prose_styles/alex
 prose_styles/proselint
+compare.py

Makefile

@@ -22,9 +22,13 @@ direnv: ## setup direnv for env
 	cp .envrc.sample .envrc && direnv allow .
 
 .PHONY: vale
-vale:
+vale: ## setup vale
 	vale sync --config .vale.ini
 
+.PHONY: pre-commit-init
+pre-commit-init: ## install pre-commit
+	pre-commit install
+
 ## Lint:
 .PHONY: lint
 lint: pre-commit ## Run linters
@@ -33,6 +37,15 @@ lint: pre-commit ## Run linters
 pre-commit: ## Run pre-commit
 	pre-commit run -a
 
+## Docs:
+.PHONY: gen-brew-docs-personal
+gen-brew-docs-personal: ## Run scripts/gen-brew-docs.py
+	uv run scripts/gen-brew-docs.py --category personal
+
+.PHONY: gen-brew-docs-work
+gen-brew-docs-work: ## Run scripts/gen-brew-docs.py
+	uv run scripts/gen-brew-docs.py --category work
+
 ## Help:
 .PHONY: help
 help: ## Show this help.

README.md

@@ -1,20 +1,6 @@
 # dotfiles
 
-## Machine Bootstrapping
-
-```bash
-                \||/
-                |  @___oo        DOTFILES INSTALLATION
-      /\  /\   / (__,,,,|        RELEASE: 2.1
-     ) /^\) ^\/ _)
-     )   /^\/   _)
-     )   _ /  / _)
- /\  )/\/ ||  | )_)
-<  >      |(,,) )__)
- ||      /    \)___)\
- | \____(      )___) )___
-  \______(_______;;; __;;;
-```
+![fastfetch](docs/assets/fastfetch-demo.jpg)
 
 Setups and configures various dotfiles, installs packages, and configures the
 host machine. This repo strives to be as declarative and idempotent as possible
@@ -72,16 +58,25 @@ sh -c "$(curl -fsLS get.chezmoi.io)" -- init --exclude=encrypted --apply $GITHUB
 - Hook Ansible into chezmoi bootstrap step
 - Identify how to install homebrew-less casks: ATEM Mini Pro, Akai Professional
   MPK Mini III Program Editor, MPK mini Software Manager
+- Generate inventory file for Ansible
+
+## Info Gathering
+
+### MAS Info Gathering
+
+```bash
+mas list
+```
 
-## Homebrew Info Gathering
+### Homebrew Info Gathering
 
-### List installed formulae
+#### List installed formulae
 
 ```bash
 brew info --json=v2 --installed | jq -r '.formulae[]|{name:select(any(.installed[]; .installed_on_request)).full_name, desc: .desc, homepage:.homepage}'
 ```
 
-### List installed casks
+#### List installed casks
 
 ```bash
 brew info --json=v2 --installed | jq -r '.casks[]|{name:.full_token, full_name:.name, desc:.desc, homepage:.homepage,}'

docs/README.md

@@ -0,0 +1,6 @@
+# My dotfiles Documentation
+
+## Homebrew Catalogs
+
+- [Personal](/docs/homebrew-install-catalog-personal.md)
+- [Work](/docs/homebrew-install-catalog-work.md)