From 8cb3e10ae360072e78ae8dee437465df33bff075 Mon Sep 17 00:00:00 2001
From: notohh <github@notohh.dev>
Date: Mon, 20 Mar 2023 00:54:23 -0400
Subject: [PATCH] feat: init docs for top level directories

---
 home/README.md     | 22 ++++++++++++++++++++++
 hosts/README.md    |  9 +++++++++
 modules/README.md  |  7 +++++++
 modules/nix.nix    |  1 -
 overlays/README.md |  3 +++
 pkgs/README.md     |  3 +++
 secrets/README.md  |  3 +++
 7 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 home/README.md
 create mode 100644 hosts/README.md
 create mode 100644 modules/README.md
 delete mode 100644 modules/nix.nix
 create mode 100644 overlays/README.md
 create mode 100644 pkgs/README.md
 create mode 100644 secrets/README.md

diff --git a/home/README.md b/home/README.md
new file mode 100644
index 0000000..0ca2039
--- /dev/null
+++ b/home/README.md
@@ -0,0 +1,22 @@
+<h1 align="center">:house_with_garden: home</h1>
+
+this directory is where all of my dotfiles live, with everything being managed by home-manager.
+
+name            | description
+--------------- | -----------
+`default.nix`   | used for commonly shared modules, for multiple home-manager configs
+`dunst`         | notification daemon
+`git`           | version control system
+`gtk`           | themes
+`helix`         | modal text editor, written in rust
+`lazygit`       | terminal based git command system
+`lf`            | terminal based file manager
+`mpv`           | media player
+`neofetch`      | fetch program
+`nushell`       | my shell of choice, written in rust
+`starship`      | terminal prompt, written in rust
+`waybar`        | wayland-specific bar
+`wayland`       | has my hyprland config, along with session variables for wayland
+`wezterm`       | my terminal of choice, written in rust
+`zathura`       | pdf viewer
+`zellij`        | terminal multiplexer, written in rust
\ No newline at end of file
diff --git a/hosts/README.md b/hosts/README.md
new file mode 100644
index 0000000..9696245
--- /dev/null
+++ b/hosts/README.md
@@ -0,0 +1,9 @@
+<h1 align="center">:computer: hosts</h1>
+
+my different hosts, each with their own unique configurations and purposes.
+
+Name            | Description
+--------------- | -----------
+`hime`          | portainer vm, hosting a ton of docker services
+`sutakku`       | (currently) my *arr stack vm
+`tsuki`         | my main machine running hyprland
\ No newline at end of file
diff --git a/modules/README.md b/modules/README.md
new file mode 100644
index 0000000..4af8a7a
--- /dev/null
+++ b/modules/README.md
@@ -0,0 +1,7 @@
+<h1 align="center">:electric_plug: modules</h1>
+
+not doing much here yet, but this currently hosts some common services / security tweaks used on all hosts.
+
+Name            | Description
+--------------- | -----------
+`services`      | inits security tweaks, and tailscale to all systems
\ No newline at end of file
diff --git a/modules/nix.nix b/modules/nix.nix
deleted file mode 100644
index 8b13789..0000000
--- a/modules/nix.nix
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/overlays/README.md b/overlays/README.md
new file mode 100644
index 0000000..588f630
--- /dev/null
+++ b/overlays/README.md
@@ -0,0 +1,3 @@
+<h1 align="center">:airplane: overlays</h1>
+
+not in use yet, will house overlays once i get comfortable using them
\ No newline at end of file
diff --git a/pkgs/README.md b/pkgs/README.md
new file mode 100644
index 0000000..7e5eac5
--- /dev/null
+++ b/pkgs/README.md
@@ -0,0 +1,3 @@
+<h1 align="center">:package: pkgs</h1>
+
+not in use currently, will house packages once i get comfortable writing them
diff --git a/secrets/README.md b/secrets/README.md
new file mode 100644
index 0000000..aacc157
--- /dev/null
+++ b/secrets/README.md
@@ -0,0 +1,3 @@
+<h1 align="center">:lock: secrets</h1>
+
+not in use currently, will host my encrypted secrets once i learn how to use either sops or agenix
\ No newline at end of file