From cb4f465b1da227c463946c96c31fd8676746ed90 Mon Sep 17 00:00:00 2001
From: punkfairie <marley@punkfairie.net>
Date: Sat, 16 Nov 2024 16:42:41 -0800
Subject: [PATCH] feat(meta): Write a real readme

---
 assets/lesbian-nix.svg | 111 +++++++++++++++++++++++++++++++++++++++++
 readme.md              |  41 ++++++++++++++-
 2 files changed, 150 insertions(+), 2 deletions(-)
 create mode 100644 assets/lesbian-nix.svg

diff --git a/assets/lesbian-nix.svg b/assets/lesbian-nix.svg
new file mode 100644
index 0000000..788c3c2
--- /dev/null
+++ b/assets/lesbian-nix.svg
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   width="420"
+   height="420"
+   viewBox="0 0 411.363 411.363"
+   version="1.1"
+   xml:space="preserve"
+   style="clip-rule:evenodd;fill-rule:evenodd;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:2"
+   id="svg12"
+   sodipodi:docname="lix.svg"
+   inkscape:export-filename="../lix.png"
+   inkscape:export-xdpi="96"
+   inkscape:export-ydpi="96"
+   inkscape:version="1.3.2 (091e20ef0f, 2023-11-25)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"><defs
+   id="defs12" /><sodipodi:namedview
+   id="namedview12"
+   pagecolor="#ffffff"
+   bordercolor="#666666"
+   borderopacity="1.0"
+   inkscape:showpageshadow="2"
+   inkscape:pageopacity="0.0"
+   inkscape:pagecheckerboard="0"
+   inkscape:deskcolor="#d1d1d1"
+   showgrid="false"
+   inkscape:zoom="1.203125"
+   inkscape:cx="174.12987"
+   inkscape:cy="174.54545"
+   inkscape:window-width="1276"
+   inkscape:window-height="1392"
+   inkscape:window-x="0"
+   inkscape:window-y="0"
+   inkscape:window-maximized="1"
+   inkscape:current-layer="svg12" />
+    
+    
+    
+    
+    
+    <g
+   id="Flake"
+   transform="translate(-186.20448,-20.133533)">
+        <g
+   id="path4861"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 247.523,-568.202 97.757,169.34 -44.925,0.422 -26.099,-45.495 -26.285,45.252 -22.322,-0.009 -11.433,-19.752 37.448,-64.392 -26.583,-46.26 z"
+   style="fill:#5277c3;stroke:#ffffff;stroke-width:10px"
+   id="path5" />
+        </g>
+        <g
+   id="use4863"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 282.807,-637.955 -97.774,169.331 -22.827,-38.696 26.35,-45.35 -52.332,-0.138 -11.153,-19.335 11.389,-19.777 74.489,0.235 26.771,-46.152 z"
+   style="fill:#d52d00;stroke:#ffffff;stroke-width:10px"
+   id="path6" />
+        </g>
+        <g
+   id="use4865"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 290.308,-502.594 195.532,0.009 -22.098,39.118 -52.45,-0.146 26.047,45.39 -11.168,19.327 -22.822,0.025 -37.041,-64.627 -53.355,-0.108 z"
+   style="fill:#d52d00;stroke:#ffffff;stroke-width:10px"
+   id="path7" />
+        </g>
+        <g
+   id="use4867"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 404.115,-576.791 -97.758,-169.34 44.926,-0.421 26.099,45.495 26.285,-45.252 22.322,0.009 11.432,19.751 -37.448,64.392 26.584,46.261 z"
+   style="fill:#d52d00;stroke:#ffffff;stroke-width:10px"
+   id="path8" />
+        </g>
+        <g
+   id="path4873"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 247.523,-568.202 97.757,169.34 -44.925,0.422 -26.099,-45.495 -26.285,45.252 -22.322,-0.009 -11.433,-19.752 37.448,-64.392 -26.583,-46.26 z"
+   style="fill:#5277c3;stroke:#ffffff;stroke-width:10px"
+   id="path9" />
+        </g>
+        <g
+   id="use4875"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 361.069,-642.826 -195.531,-0.01 22.097,-39.117 52.45,0.145 -26.047,-45.389 11.169,-19.327 22.822,-0.025 37.041,64.627 53.354,0.108 z"
+   style="fill:#d362a4;stroke:#ffffff;stroke-width:10px"
+   id="path10" />
+        </g>
+        <g
+   id="use4877"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 368.697,-507.074 97.774,-169.33 22.828,38.696 -26.35,45.35 52.332,0.137 11.153,19.336 -11.389,19.777 -74.49,-0.235 -26.771,46.152 z"
+   style="fill:#a30262;stroke:#ffffff;stroke-width:10px"
+   id="path11" />
+        </g>
+        <g
+   id="path3336-6"
+   transform="translate(66.1334,798.311)">
+            <path
+   d="m 247.639,-568.311 97.758,169.341 -44.926,0.421 -26.099,-45.495 -26.285,45.252 -22.322,-0.009 -11.433,-19.752 37.449,-64.392 -26.584,-46.26 z"
+   style="fill:#ff9a56;stroke:#ffffff;stroke-width:10px"
+   id="path12" />
+        </g>
+    </g>
+</svg>
diff --git a/readme.md b/readme.md
index 075318d..8350722 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,40 @@
-# mar does dotfiles
+<div align="center">
+  <img width="200" src="./assets/lesbian-nix.svg" alt="The Nix logo recolored with the colors of the lesbian flag.">
+  <h1>marleyOS</h1>
+  <img alt="Last Commit" src="https://img.shields.io/gitea/last-commit/punkfairie/nix?gitea_url=https%3A%2F%2Fcodewith.babesonthe.net&style=for-the-badge&logo=git&logoColor=d362a4&label=updated&color=d362a4">
+  <img alt="Build With" src="https://img.shields.io/badge/built_with-nix-ff9a56?style=for-the-badge&logo=nixos&logoColor=ff9a56">
+  <br><br>
+  <p>My dotfiles.</p>
+</div>
 
-My dotfiles - as managed by [Nix](https://nixos.org/) and [Home Manager](https://github.com/nix-community/home-manager).
+## 🩷 About
+
+This is my personal system configuration. You are welcome to use it, but I
+wouldn't advise doing so. It's written to be publicly accessible but not
+publicly released, therefore things are likely to break.
+
+## 🥚 Inputs
+
+- [Snowfall Lib](https://snowfall.org/guides/lib/quickstart/)
+- [Home Manager](https://nix-community.github.io/home-manager/)
+- [Rose Pine](https://codewith.babesonthe.net/punkfairie/rose-pine-nix)
+
+## 🐣 Outputs
+
+- `homes`: Home manager config
+  - `homes/<system>/marley@nyx`: My main desktop. Currently running Arch Linux
+    but will be switched to NixOS once I've finished migrating my dotfiles.
+- `modules`: Most config is done here. The file structure is pretty
+  self-explanatory.
+  - `modules/{home,nixos,darwin}/base`: Anything in a base folder directly under
+    a platform folder is always enabled and does not include a `<module>.enable`
+    option.
+    - `modules/{home,nixos,darwin}/<category>/base`: These are not subject to the
+      above, they simply denote options that apply to the whole category.
+- `overlays`
+  - `overlays/figlet`: Adding in [xero's custom fonts](https://github.com/xero/figlet-fonts/).
+
+## 🫶 Credits
+
+- [jakehamilton/config](https://github.com/jakehamilton/config)
+- [the nix logo used in this readme](https://lix.systems/)