commit 078625942684247e07970690617b44e1db0e4930
parent f756fa0e6eb231e79f98f479595a0191f7fc4d98
Author: bdmfegys@duck.com <bdmfegys@duck.com>
Date: Sun, 28 Apr 2024 14:16:06 -0400
README.md: update for all patches and submodules along with links and more helpful info
Diffstat:
1 file changed, 18 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -1,20 +1,31 @@
-# Birdwm, dwm for birds!
+# Birdwm, dwm for birds, by a bird!
## Patches and features
-- [xrdb](https://dwm.suckless.org/patches/xrdb): Birdwm patch that reads [xresources](https://dwm.suckless.org/patches/xresources/) colors/variables (i.e. works with `pywal`, etc.).
+- [xrdb](https://dwm.suckless.org/patches/xrdb): Birdwm patch that reads [Xresources](https://dwm.suckless.org/patches/xresources) colors/variables (i.e. works with `pywal`, etc.).
- [scratchpads](https://dwm.suckless.org/patches/scratchpads): Accessible with <kbd>mod+y</kbd>.
-- [uselessgaps](https://dwm.suckless.org/patches/uselessgap/): Adds useless gaps around windows, except in monocle mode.
+- [uselessgaps](https://dwm.suckless.org/patches/uselessgap): Adds useless gaps around windows, except in monocle mode.
- [alpha](https://dwm.suckless.org/patches/alpha): Allows birdwm to have translucent bars, with opaque text.
-- [systray](https://dwm.suckless.org/patches/systray/): System tray patch for birdwm in the corner of the bar
-- [winicon](https://dwm.suckless.org/patches/winicon/): Patch for birdwm to display the icon of currently focused program
+- [systray](https://dwm.suckless.org/patches/systray): System tray patch for birdwm in the corner of the bar
+- [winicon](https://dwm.suckless.org/patches/winicon): Patch for birdwm to display the icon of currently focused program
+- [autostart](https://dwm.suckless.org/patches/autostart)(modified): runs selected script upon startup
+
+- [desktop entry](https://git.mrgrouse.com/mrgrouse/birdwm/src/branch/main/extras/birdwm.desktop): desktop entry for easy startup in display managers
+- [various scripts](https://git.mrgrouse.com/mrgrouse/birdwm/src/branch/main/extras): various shell scripts for things such as:
+ - restarting daemons and other programs
+ - taking screenshots from a selection
+ - setting and getting volume for/from pulse audio
+
+- submodules for my forks of other suckless programs, such as:
+ - [slstatus](https://git.mrgrouse.com/mrgrouse/slstatus): a status bar with few patches for birdwm
+ - [slock](https://git.mrgrouse.com/mrgrouse/slock): a simple screen lock tool with Xresources compatibility
## Installation for birdwm on linux distros
-```bash
+```sh
git clone https://git.tetraonini.online/grouse/birdwm
cd birdwm
sudo make install
```
-<!-- There is also a `PKGBUILD` usable on distributions with pacman. Run `makepkg -si` instead of `sudo make install`. -->
+<!-- There is also a `PKGBUILD` for compatible distros. Run `makepkg -si` instead of `sudo make install`. -->
