chore: add a CC0-1.0 LICENSE

LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

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,6 @@
 
       packages."${system}" = {
         wb32dfu-udev-rules = pkgs.callPackage ./packages/wb32dfu-udev-rules { };
-        zenergy = pkgs.callPackage ./packages/zenergy.nix { };
       };
 
       nixosModules = {
@@ -89,8 +88,9 @@
 
       templates.default = {
         path = ./modules/template;
-        description = "A NixOS & Home-Manager template to get started with the https://github.com/wizardlink/linuxware
-        configuration.";
+        description = ''
+          A NixOS & Home-Manager template to get started with the https://github.com/wizardlink/linuxware configuration.
+        '';
       };
     };
 }

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,18 @@ 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].
 
+Unfortunately this cannot be outputted as a package in the flake since to create a derivation the `kernel` parameter
+must be present, which, each user will have their own kernel package.
+
+Thus you need to copy the `zenergy.nix` file somewhere in your configuration and inside `boot.extraModulePackages` pass
+the package with the following expression: `config.boot.kernelPackages.callPackage ./path/to/zenergy.nix`; successfully
+installing the package onto your system.
+
 ## 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)