docs: touch-ups

README.md

@@ -1,6 +1,6 @@
 # linuxware
 
-This repository contains the configuration of my main Linux based system(s), currently this repository consist of a
+This repository contains the configuration of my main Linux based system(s), currently this repository consists of a
 [NixOS] system configuration alongside [dotfiles] generated by [Home Manager] and [dotfiles] maintained by me.
 
 ## Navigation guide

assets/README.md

@@ -0,0 +1,42 @@
+## Desktop
+
+![image](./screenshots/full-system.png)
+
+### Window gaps
+
+![image](./screenshots/hyprland-gaps.png)
+
+### Window borders
+
+![image](./screenshots/hyprland-active.png)
+![image](./screenshots/hyprland-inactive.png)
+
+## Programs
+
+### Neovim
+
+![image](./screenshots/neovim-dashboard.png)
+![image](./screenshots/neovim-nix.png)
+![image](./screenshots/neovim-rust.png)
+
+### Alacritty & Fish
+
+![image](./screenshots/alacritty-and-fish.png)
+
+### Rofi
+
+![image](./screenshots/rofi.png)
+
+### Waybar
+
+![image](./screenshots/waybar.png)
+
+### Emacs
+
+![image](./screenshots/doomemacs.png)
+
+## System
+
+### SDDM background
+
+![image](./sddm/Background.jpg)

flake.nix

@@ -74,7 +74,7 @@
 
       packages."${system}" = {
         wb32dfu-udev-rules = pkgs.callPackage ./packages/wb32dfu-udev-rules { };
-        zenergy = pkgs.callPackage ./packages/zenergy.nix { };
+        zenergy = ./packages/zenergy.nix;
       };
 
       nixosModules = {

modules/README.md

@@ -6,3 +6,5 @@ This directory encompasses all modules/resources that are exported by this repos
 - [neovim](./neovim)
 - [emacs](./emacs)
 - [template](./template)
+
+> _Be sure to click the hyperlinks for the relevant documentation._

modules/neovim/README.md

@@ -39,5 +39,6 @@ The theme I'm using is [catppuccin](https://github.com/catppuccin) in case you'r
 
 [neovim]: https://neovim.io/
 [Home Manager]: https://github.com/nix-community/home-manager
+[nixos]: https://nixos.org
 [nixd]: https://github.com/nix-community/nixd/
 [ollama]: https://ollama.com/

packages/README.md

@@ -4,11 +4,15 @@ This is a kernel driver that adds the ability for user to fetch power draw data
 [nixpkgs], so you shouldn't use this package _unless_ it is broken in your current
 version of [nixpkgs].
 
+To use it you must add to `boot.extraModulePackages` the following expression: `<nixpkgs>.callPackage
+<linuxware>.packages.x86_64-linux.zenergy { kernel = <kernel package here> }` substituting the tags with their
+appopriate replacements.
+
 ## wb32dfu-udev-rules
 
 This package installs the udev rules necessary to allow flashing QMK/Vial onto keyboards that use WB32-DFU bootloaders.
 
-It is also meant to be used in tandem with [NixOS] using the
+It is meant to be used in tandem with [NixOS] using the
 [`services.udev.packages`](https://search.nixos.org/options?query=services.udev.packages) configuration.
 
 

shared/README.md

@@ -36,6 +36,10 @@ In this directory you will find the configuration for [NixOS] and [Home Manager]
 
 #### Screenshots
 
+Alacritty & Fish:
+
+![image](/assets/screenshots/alacritty-and-fish.png)
+
 Waybar:
 
 ![image](/assets/screenshots/waybar.png)