From b81a61fd335b199b19729c8659553d077185e5d3 Mon Sep 17 00:00:00 2001
From: matt1432 <matt@nelim.org>
Date: Wed, 17 Jan 2024 20:16:26 -0500
Subject: [PATCH] docs: add devices readme

---
 README.md                                     | 19 +++-------
 common/home/neovim/default.nix                |  2 +
 devices/README.md                             | 38 +++++++++++++++++++
 .../config/ts/quick-settings/button-grid.ts   |  1 +
 modules/hyprland/default.nix                  | 10 ++++-
 5 files changed, 55 insertions(+), 15 deletions(-)
 create mode 100644 devices/README.md

diff --git a/README.md b/README.md
index 60a291d2..51453d29 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,11 @@
 # My NixOS configs
 
-what i want to do:
+## About
 
-- add auto-rotate widget in ags control center
-- when multiple widgets open, clicking on a background one puts it forward
+This repo is my complete configuration of machines I own,
+running NixOS or Nix. I tend to mix Home-Manager and NixOS
+a lot to make my custom modules by using my global vars system
+explained [here](./devices)
 
-## Docs
-
-Since I use my laptop with one user, I symlinked the configs to my home
+For QOL, I symlink the configs to my main user's home
 directory following the tutorial [here](https://nixos.wiki/wiki/NixOS_configuration_editors)
-
-### Discord themes
-
-```
-https://markchan0225.github.io/RoundedDiscord/RoundedDiscord.theme.css
-https://raw.githubusercontent.com/dracula/BetterDiscord/master/Dracula_Official.theme.css
-```
diff --git a/common/home/neovim/default.nix b/common/home/neovim/default.nix
index 32a4bc01..a6bd1cde 100644
--- a/common/home/neovim/default.nix
+++ b/common/home/neovim/default.nix
@@ -187,6 +187,8 @@ in {
             }
           ]
           ++ optionals neovimIde [
+            markdown-preview-nvim
+
             # Coc configured
             coc-css
             coc-eslint
diff --git a/devices/README.md b/devices/README.md
new file mode 100644
index 00000000..15fdd204
--- /dev/null
+++ b/devices/README.md
@@ -0,0 +1,38 @@
+# Devices
+
+This directory encompasses every device's main configuration file.
+
+## List of my Devices
+
+| Name       | Description                                                                                             |
+| ---------- | ------------------------------------------------------------------------------------------------------- |
+| `android`  | My [Nix-On-Droid](https://github.com/nix-community/nix-on-droid) configuration for my OnePlus 9 Pro |
+| `binto`    | My desktop PC with a multi-monitor setup and an NVIDIA (cringe) 3070 |
+| `cluster`  | WIP |
+| `oksys`    | A very old Acer laptop that went from sailing the seas for years to becoming my web server and VPN host |
+| `servivi`  | A gaming PC in a previous life, it is now used to slowly convert my Proxmox server to NixOS |
+| `wim`      | My 2-1 Lenovo Laptop that I use for uni |
+
+## Global Vars
+
+In every device's `default.nix`, you'll find these [settings](../common/vars.nix)
+
+```nix
+# $FLAKE/devices/<name>/default.nix
+
+vars = {
+  mainUser = "matt";
+  hostName = "wim";
+  ...
+};
+```
+
+from these declared settings, I get access to global variables
+that are different on each host using a 'let in' block:
+
+```nix
+let
+  inherit (config.vars) mainUser ...;
+in {
+  ...
+```
diff --git a/modules/ags/config/ts/quick-settings/button-grid.ts b/modules/ags/config/ts/quick-settings/button-grid.ts
index 61726019..8af781c8 100644
--- a/modules/ags/config/ts/quick-settings/button-grid.ts
+++ b/modules/ags/config/ts/quick-settings/button-grid.ts
@@ -321,6 +321,7 @@ const SecondRow = () => Row({
             }],
         }),
 
+        // TODO: replace this with Rotation Toggle and move lock to a separate section
         GridButton({
             command: () => {
                 execAsync(['lock']).catch(print);
diff --git a/modules/hyprland/default.nix b/modules/hyprland/default.nix
index 8c1c6aca..c6cb766d 100644
--- a/modules/hyprland/default.nix
+++ b/modules/hyprland/default.nix
@@ -216,6 +216,7 @@ in {
 
     home.packages = with pkgs; [
       # School
+      xournalpp
       virt-manager
       jetbrains.idea-ultimate
       libreoffice-fresh # TODO: declarative conf?
@@ -229,12 +230,17 @@ in {
       photoqt
       nextcloud-client
       jellyfin-media-player
-      xournalpp
+      prismlauncher-qt5
+
+      /*
+      Discord themes for Vencord
+      https://markchan0225.github.io/RoundedDiscord/RoundedDiscord.theme.css
+      https://raw.githubusercontent.com/dracula/BetterDiscord/master/Dracula_Official.theme.css
+      */
       (pkgs.discord.override {
         withOpenASAR = true;
         withVencord = true;
       })
-      prismlauncher-qt5
 
       # tools
       wl-color-picker