birdwm

birdwm - mrgrouse's daily driver fork of suckless' dwm. Contains many patches and is currently loosely maintained.
Log | Files | Refs | README | LICENSE

README.md (2646B)

      1 # Birdwm, dwm for birds, by a bird!
      2 ![Birdwm!](https://git.mrgrouse.com/mrgrouse/birdwm/raw/branch/main/extras/screenshot.png)
      3 
      4 ## Dependencies:
      5 - libxinerama
      6 - freetype2
      7 - libev
      8 - execline (optional: only for [my specific startup script](/mrgrouse/birdwm/src/branch/main/autostart/autostart.e))
      9 - a few more, i haven't checked yet (don't hurt me please)
     10 
     11 ## Patches and Features
     12 
     13 - [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.).
     14 - [scratchpads](https://dwm.suckless.org/patches/scratchpads): Accessible with <kbd>mod+y</kbd>.
     15 - [uselessgaps](https://dwm.suckless.org/patches/uselessgap): Adds useless gaps around windows, except in monocle mode.
     16 - [alpha](https://dwm.suckless.org/patches/alpha): Allows birdwm to have translucent bars, with opaque text.
     17 - [systray](https://dwm.suckless.org/patches/systray): System tray patch for birdwm in the corner of the bar
     18 - [winicon](https://dwm.suckless.org/patches/winicon): Patch for birdwm to display the icon of currently focused program
     19 - [autostart](https://dwm.suckless.org/patches/autostart)(modified): runs selected script upon startup
     20 - [birdmenu-emoji](https://github.com/porras/dmenu-emoji)(modified): runs dmenu-emoji script (modified for birdmenu), accessible via <kbd>mod+e</kbd>.
     21 
     22 ### Misc. features
     23 - [desktop entry](https://git.mrgrouse.com/mrgrouse/birdwm/src/branch/main/extras/birdwm.desktop): desktop entry for easy startup in display managers
     24 - [various scripts](https://git.mrgrouse.com/mrgrouse/birdwm/src/branch/main/extras): various shell scripts for things such as:
     25   - restarting daemons and other programs
     26   - taking screenshots from a selection
     27   - setting and getting volume for/from pulse audio
     28 
     29 - strong compatibility with my forks of other suckless programs, such as:
     30   - [slstatus](https://git.mrgrouse.com/mrgrouse/slstatus): a status bar with few patches for birdwm
     31   - [slock](https://git.mrgrouse.com/mrgrouse/slock): a simple screen lock tool with Xresources compatibility
     32   - [birdmenu](https://git.mrgrouse.com/mrgrouse/birdmenu): my dmenu fork, including Xresources, password mode, and mouse clickability.
     33   - [birdterm](https://git.mrgrouse.com/mrgrouse/birdterm): my st (simple terminal) fork, including transparency and scrollback.
     34 
     35 ## Installation for birdwm on linux distros
     36 ### See `config.h` for customization options
     37 
     38 ```sh
     39 git clone https://git.mrgrouse.com/mrgrouse/birdwm
     40 cd birdwm
     41 sudo make install
     42 ```
     43 
     44 <!-- There is also a `PKGBUILD` for compatible distros. Run `makepkg -si` instead of `sudo make install`. -->