docs: update documentation

3 files changed, 91 insertions, 28 deletions

diff --git a/FUNDING.yml b/FUNDING.yml
deleted file mode 100644
index c7c9a22..0000000
--- a/FUNDING.yml
+++ /dev/null
@@ -1,2 +0,0 @@
-custom: ["https://lukesmith.xyz/donate.html"]
-github: lukesmithxyz
diff --git a/LICENSE b/LICENSE
index 1e1b5a4..3d1012e 100644
--- a/LICENSE
+++ b/LICENSE
@@ -18,6 +18,7 @@ MIT/X Consortium License
 © 2015-2016 Eric Pruitt <[email protected]>
 © 2016-2017 Markus Teich <[email protected]>
 © 2019-2020 Luke Smith <[email protected]>
+© 2023-2024 Fuwn <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"),
diff --git a/README.md b/README.md
index 1c15d73..8b87444 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,100 @@
-# Luke's build of dwm
+# 🪄 Sei
 
-## FAQ
+> A fixed, patched, and modified window manager from a dwm 6.4 base
 
-> What are the bindings?
+[![Screenshot](https://i.imgur.com/GEDBZ6N.png)](https://i.imgur.com/GEDBZ6N.png)
 
-This is suckless, mmmbud, the source code is the documentation! Check out [config.h](config.h).
+<a href="https://anilist.co/character/188173/" target="_blank"><img src="https://i.imgur.com/MVp2ULn.png" align="right" height="250vw"></a>
 
-Okay, okay, actually I keep a readme in `larbs.mom` for my whole system, including the binds here.
-Press <kbd>super+F1</kbd> to view it in dwm (zathura is required for that binding).
-I haven't kept `man dwm`/`dwm.1` updated though. PRs welcome on that, lol.
+## Installation
 
-## Patches and features
+```bash
+git clone https://github.com/Fuwn/seiwm.git
+cd seiwm
+sudo ninja install
+```
 
-- [Clickable statusbar](https://dwm.suckless.org/patches/statuscmd/) with my build of [dwmblocks](https://github.com/lukesmithxyz/dwmblocks).
-- Reads [xresources](https://dwm.suckless.org/patches/xresources/) colors/variables (i.e. works with `pywal`, etc.).
-- scratchpad: Accessible with <kbd>mod+shift+enter</kbd>.
-- New layouts: bstack, fibonacci, deck, centered master and more. All bound to keys <kbd>super+(shift+)t/y/u/i</kbd>.
-- True fullscreen (<kbd>super+f</kbd>) and prevents focus shifting.
-- Windows can be made sticky (<kbd>super+s</kbd>).
-- [hide vacant tags](https://dwm.suckless.org/patches/hide_vacant_tags/) hides tags with no windows.
-- [stacker](https://dwm.suckless.org/patches/stacker/): Move windows up the stack manually (<kbd>super-K/J</kbd>).
-- [shiftview](https://dwm.suckless.org/patches/nextprev/): Cycle through tags (<kbd>super+g/;</kbd>).
-- [vanitygaps](https://dwm.suckless.org/patches/vanitygaps/): Gaps allowed across all layouts.
-- [swallow patch](https://dwm.suckless.org/patches/swallow/): if a program run from a terminal would make it inoperable, it temporarily takes its place to save space.
+### Build Dependencies
 
+- [FreeType2](https://freetype.org/)
+- [libX11](https://x.org/releases/current/doc/libX11/libX11/libX11.html)
+- [libXft](https://gitlab.freedesktop.org/xorg/lib/libxft)
+- [Imlib2](https://docs.enlightenment.org/api/imlib2/html/index.html)
+- [GNU FriBidi](https://github.com/fribidi/fribidi)
+- [libXinerama](https://gitlab.freedesktop.org/xorg/lib/libxinerama)
+- [xcb](https://xcb.freedesktop.org/)
 
-## Installation for newbs
+## Recommendations
 
-```bash
-git clone https://github.com/LukeSmithxyz/dwm.git
-cd dwm
-sudo make install
-```
+- Use [Compfy](https://github.com/Fuwn/compfy) for X11 compositing for
+  "transparency, background blurring, rounded corners, animations and way more!"
+- Install and specify [Zig](https://ziglang.org/) as `CC` for improved memory
+  allocation efficiency and runtime speed: `CC="zig cc" sudo ninja install`
+
+## Sei Specific Fixes & Patches
+
+- Removed refresh rate limit
+- Fixed tray position and button responsiveness for use with custom padding
+- Reactive bar toggling: If the user has manually toggled the bar visibility
+  using <kbd>mod+b</kbd>, the bar
+  will stay locked with the same visibility. If the user has not manually
+  toggled the bar visibility, the bar visibility will
+  reflect that of the full-screen state.
+- Clear nametag patch's current tag name upon new assignment and reset tag name
+  to default upon empty string. (why is this not default behaviour?)
+- Append mode for nametag: Chose between appending the name of a tag to the
+  default name or to overwrite it completely
+- XSession desktop entry
+- centretitle patch toggle
+- `followclient`:
+  - The view will follow the client when sent to an empty tag
+  - The focus and cursor will follow the client when sent to a new monitor
+- `systraypinning` toggle fix: If `systraypinning` is enabled, the system tray will
+  only toggle its visibility if the mutation originates from the monitor it is
+  pinned on.
+
+## "Official" Patches
 
-There is also a `PKGBUILD` usable on distributions with pacman. Run `makepkg -si` instead of `sudo make install`.
+- [xresources](https://dwm.suckless.org/patches/xresources/): Applies colours
+  and other variables (i.e. using [`pywal`](https://github.com/dylanaraps/pywal)
+  , etc.)
+- [scratchpad](https://dwm.suckless.org/patches/scratchpad/): Accessible using
+  <kbd>mod+shift+enter</kbd>
+- [fibonacci](https://dwm.suckless.org/patches/fibonacci/),
+  [deck](https://dwm.suckless.org/patches/deck/),
+  [centeredmaster](https://dwm.suckless.org/patches/centeredmaster/), and more:
+  New layout options bound to keys <kbd>super+(shift+)t/y/u/i</kbd>
+- [actualfullscreen](https://dwm.suckless.org/patches/actualfullscreen/): Using
+  <kbd>super+f</kbd>, and prevents focus shifting
+- [sticky](https://dwm.suckless.org/patches/sticky/): Persist window across all
+  tags using <kbd>super+s</kbd>
+- [statuscmd](https://dwm.suckless.org/patches/statuscmd/): A clickable status
+  bar, applied if using Luke Smith's build of [dwmblocks](https://github.com/lukesmithxyz/dwmblocks)
+- [hide vacant tags](https://dwm.suckless.org/patches/hide_vacant_tags/): Hides
+  tags with no windows
+- [stacker](https://dwm.suckless.org/patches/stacker/): Move windows up the
+  stack manually using <kbd>super-K/J</kbd>
+- [shiftview](https://dwm.suckless.org/patches/nextprev/): Cycle through tags
+  using <kbd>super+g/;</kbd>
+- [vanitygaps](https://dwm.suckless.org/patches/vanitygaps/): Gaps allowed
+  across all layouts
+- [swallow](https://dwm.suckless.org/patches/swallow/): Replaces terminal with
+  program if spawned from terminal
+- [systray](https://dwm.suckless.org/patches/systray/): Functional system tray
+- [bidi](https://dwm.suckless.org/patches/bidi/): Bidirectional text support
+- [barpadding](https://dwm.suckless.org/patches/barpadding/): Padding for status
+  bar
+- [winicon](https://dwm.suckless.org/patches/winicon/): Active window icon shown
+  in status bar
+- [attachaside](https://dwm.suckless.org/patches/attachaside/): Attach and focus
+  new clients to the side instead of making it the new master
+- [zoomswap](https://dwm.suckless.org/patches/zoomswap/): Swap client and master
+  in-place when assigning new master
+- [pertag](https://dwm.suckless.org/patches/pertag/): Tag-unique layouts
+- [combo](https://dwm.suckless.org/patches/combo/): View multiple tags at once by
+  holding down the mod key and one or more tag
+- [nametag](https://dwm.suckless.org/patches/nametag/): Name tags using <kbd>mod+n</kbd>
+- [centretitle](https://dwm.suckless.org/patches/centretitle/): Optionally
+  centre the focused client's title
+- [cursor](https://dwm.suckless.org/patches/cursorwarp/): Warps the mouse cursor
+  to the center of the target window when changing focus