feat: init docs for top level directories

This commit is contained in:
notohh 2023-03-20 00:54:23 -04:00
parent b929a56e2f
commit 8cb3e10ae3
Signed by: notohh
GPG key ID: BD47506D475EE86D
7 changed files with 47 additions and 1 deletions

22
home/README.md Normal file
View file

@ -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

9
hosts/README.md Normal file
View file

@ -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

7
modules/README.md Normal file
View file

@ -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

View file

@ -1 +0,0 @@

3
overlays/README.md Normal file
View file

@ -0,0 +1,3 @@
<h1 align="center">:airplane: overlays</h1>
not in use yet, will house overlays once i get comfortable using them

3
pkgs/README.md Normal file
View file

@ -0,0 +1,3 @@
<h1 align="center">:package: pkgs</h1>
not in use currently, will house packages once i get comfortable writing them

3
secrets/README.md Normal file
View file

@ -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