From 2e7ee0e4ca2803763666ced164c16caabb8930b3 Mon Sep 17 00:00:00 2001 From: Kat Inskip Date: Sun, 14 Jul 2024 09:34:40 -0700 Subject: [PATCH] docs: README update --- README.md | 47 +++++------------------------------------------ 1 file changed, 5 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index aed00dee..a6a0adc6 100644 --- a/README.md +++ b/README.md @@ -2,43 +2,6 @@ This repository is my personal infrastructure repository. It contains the Nix and Terraform I leverage. -## Structure - -| Path | Purpose | -| -------------- | ------------------------------------------------------------------------------------------------- | -| common/ | Common imports to NixOS and macOS systems | -| darwin/ | macOS (nix-darwin) related configuration | -| darwin/common | Imported into all nix-darwin systems | -| kat | Configurations relevant to my use of a computer, including base16 + vscodium | -| kat/common | Disables manuals | -| kat/gnome | GNOME. Including dconf configuration. | -| kat/gui | Packages I use on a host that has a WM / DE. | -| kat/neovim | Text editor of choice, though VSCode or a JetBrains IDE normally takes forefront for development. | -| kat/shell | My shell configs. I use zsh, fzf, z, starship, eza, rg, fd, sd, ... | -| kat/sway | My tiling window manager of choice (though I'll happily take i3 too) | -| kat/user | Per-system type configurations. Data on my user. | -| modules/nixos | An area for more reusable NixOS modules | -| modules/darwin | An area for more reusable nix-darwin modules | -| modules/home | An area for more reusable home-manager modules | -| nixos/ | NixOS related configuration | -| nixos/common | Imported into all NixOS systems | -| nixos/hardware | Per-machine hardware configuration | -| nixos/roles | Roles / services / ... | -| packages/ | Package overlay | -| shells/ | nix develop shells / devShells | -| systems/ | A collection of NixOS hosts and a nix-darwin host. | -| tf/ | Terraform! | -| .envrc | direnv config | -| .sops.yaml | Secrets (user & hosts) config | -| default.nix | flake-compat | -| flake.nix | flake inputs | -| formatter.nix | flake formatter of choice | -| outputs.nix | flake outputs | -| overlays.nix | nixpkgs overlays | -| pkgs.nix | nixpkgs config | -| std.nix | Overlay to [nix-std](https://github.com/chessai/nix-std) | -| tree.nix | The configuration system used by my import handler, [tree](https://github.com/kittywitch/tree) | - ## Usage ```bash @@ -69,10 +32,10 @@ sops ./systems/yukari.yaml sops -d ./systems/yukari.yaml # plan an apply +cd tf/ terraform plan + +# update nodes CI +# obtain storepath from nix run github:arcnmx/ci/v0.7 >~< + nix run --argstr config "./ci/nodes.nix" -f "/nix/store/frf40m951652jv6qqkzfhr6n6r332gk9-source" run.gh-actions-generate --show-trace ``` - - -## To-dos - -- [ ] Figure out roles/ vs profiles more.