aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1ab1d62
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Overview
+This is my personal build of dwm. It is pretty basic without too much configuration changes.
+
+# Requirements
+- GoMono Nerd Font (For the bar font)
+- rofi (optional)
+- rofimoji (optional)
+- xresources (optional)
+- librewolf (optional)
+- slock (optional)
+
+# Hotkeys
+- `Alt` is still the mod key.
+- `Alt` + `Shift` + `c`: kill client
+- `Alt` + `Shift` + `q`: kill dwm
+- `Alt` + `Shift` + `Space`: toggle floating
+- `Alt` + `d`: terminal (default: st)
+- `Alt` + `e`: emoji keyboard (rofimoji)
+- `Alt` + `Shift` + `b`: browser (default: librewolf)
+- `Alt` + `Shift` + `l`: lock (default: slock)
+- `Alt` + `Enter`: switch current window with master
+- `Alt` + `Tab`: Toggle between two windows
+- `Alt` + `h`: decrease master size
+- `Alt` + `l`: increase master size
+- `Alt` + `j`: focus stack (down)
+- `Alt` + `k`: focus stack (up)
+
+# Patches
+- [autostart](https://dwm.suckless.org/patches/autostart/)
+ - `~/.local/share/dwm/autostart.sh` & `~/.local/share/dwm/autostart_blocking.sh` need to be created. programs listed in `autostart.sh` are running continuously, which programs in `autostart_blocking.sh` must terminate for dwm to start.
+- [xresources](https://dwm.suckless.org/patches/xresources/)
+- [uselessgap](https://dwm.suckless.org/patches/uselessgap/)
+
+# Install
+
+`sudo make clean install`