overhauled the README.md

Sadoon AlBader 1 year ago
parent 5a5ab3beac
commit c5535f2f00
  1. 37

@ -1,38 +1,25 @@
# Luke's build of dwm
# dwm-xfce4: Customized dwm to integrate with the Xfce4 desktop
## FAQ
## manpage is outdated, will look into it later. Check out config.h for keybindings and such
> What are the bindings?
This is suckless, mmmbud, the source code is the documentation! Check out [config.h](config.h).
Okay, okay, actually I keep a readme in `larbs.mom` for my whole system, including the binds here.
Press `super+F1` 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.
## Patches and features
- Clickable statusbar with my build of [dwmblocks](https://github.com/lukesmithxyz/dwmblocks).
- Reads xresources colors/variables (i.e. works with `pywal`, etc.).
- scratchpad: Accessible with mod+shift+enter.
- Integrates with xfce4-panel instead of dwm's top bar. Uses [anybar](https://dwm.suckless.org/patches/anybar/)
- New layouts: bstack, fibonacci, deck, centered master and more. All bound to keys `super+(shift+)t/y/u/i`.
- True fullscreen (`super+f`) and prevents focus shifting.
- Windows can be made sticky (`super+s`).
- stacker: Move windows up the stack manually (`super-K/J`).
- Windows can be made sticky (`Super+Shift+s`).
- stacker: Move windows up the stack manually (`Super-Shift-Left/Right`).
- shiftview: Cycle through tags (`super+g/;`).
- vanitygaps: Gaps allowed across all layouts.
- swallow patch: if a program run from a terminal would make it inoperable, it temporarily takes its place to save space.
- tmux swallow patch: tmux is now also considered a terminal and can be swallowed. Thank you [soystemd](https://gist.github.com/soystemd/0ac35d048672c63d7fc3afb1fde4c5f2)
- tabbed swallows now, useful for vimb+tabbed and using my config (to be released) that bind Ctrl+n to open current page in alternate browser.
- Most windows that shouldn't tile don't. Includes xfce4-settings, timeshift-gtk, xfce4-taskmanager, gnome-calculator, file-roller, xfburn, and all "wrapper-2.0" instances (xfce4-panel plugins and such)
## Installation for newbs
git clone https://github.com/LukeSmithxyz/dwm
cd dwm
sudo make install
Users of Arch-based distros can also install it from the AUR as [dwm-luke-git](https://aur.archlinux.org/packages/dwm-luke-git).
## Bugs and deficiencies
## Please install `libxft-bgra`!
- Cannot know which tag you are on because dwm's bar is hidden, need to find a way to display that on xfce4-panel
- Clicking on the time to display the mini calendar view will cause windows to overlap with xfce4-panel, remedy with `xfce4-panel -r`
- `Mod+D` which opens up WhiskerMenu may not work unless your mouse is hovering over the location of the menu, use `Mod+Shift+D` to use the regular Application Launcher.
This build of dwm does not block color emoji in the status/info bar, so you must install [libxft-bgra](https://aur.archlinux.org/packages/libxft-bgra/) from the AUR, which fixes a libxft color emoji rendering problem, otherwise dwm will crash upon trying to render one. Hopefully this fix will be in all libxft soon enough.