speedwm-personal/docs/dependencies

53 lines
2.7 KiB
Plaintext
Raw Normal View History

-- Dependencies --
These are absolutely necessary, speedwm will NOT compile without them
2022-10-08 21:47:30 +02:00
- libxft
- libXinerama
- Can be disabled through editing toggle.mk if you're not interested in multiple monitors.
- imlib2
- Tag previews, Window icons. Can be disabled through editing toggle.mk and toggle.h if you don't want these features.
2022-10-08 21:47:30 +02:00
- yajl
- Required for the IPC patch. If the IPC patch is disabled, you do not need this.
- tcc
- Very minimal C compiler that speedwm uses to speed up compile times. If you don't want this dependency, edit host.mk and set CC to 'cc' (or what you prefer).
-- Features --
These are necessary for certain features. By default speedwm will prevent an installation without them but you can bypass these if you want.
If you want to use an alternative, change it in options.h.
- dmenu
2022-08-23 16:35:54 +02:00
- NOTE: dmenu is required for most scripts included with this build of speedwm. My build is required for proper Pywal support.
- If you do not have the password, grid and center patches, you must disable them in ~/.config/speedwm-de/global/config by setting two variables to false.
- picom
2022-08-23 16:35:54 +02:00
- Optional but speedwm looks sort of ugly without it.
- xclip (Required for clipboard support by a few scripts, will start automatically)
2022-08-23 16:35:54 +02:00
- xwallpaper (Required to set wallpapers)
- xmodmap
- Required if you want the Alt+Tab to have proper keybinds.
- xrdb (Install if you want .Xresources support)
- pywal (Install if you want pywal support. Requires swal aka the default way to set wallpapers)
- wmctrl (Needed for proper window management)
- slock (Required for screen locking)
2022-08-23 16:35:54 +02:00
- If you want to display a message, you need the text patch.
- If you have the background image patch, you can set the image to ~/.config/speedwm-de/swal/CurrentWallpaper. It is a symlink to the current wallpaper.
- maim (Required for built in 'speedwm-screenshotutil' script)
2022-10-02 22:59:51 +02:00
- j4-dmenu-desktop
- Required for dmenu desktop entries. speedwm will not prevent installation without this because it doesn't provide much functionality.
-- Software --
This build of speedwm comes with binds for software.
These must be installed by default but you can change what software is required by editing 'options.h' and running 'make clean install'.
You can also remove keybinds by editing 'keybinds.h' and running 'make clean install'.
- st (Terminal)
- GNU IceCat (Web browser)
- htop (Status monitor)
- newsboat (RSS reader)
- zathura (PDF reader)
- alsa-utils (Required for audio controls)
2022-08-23 16:35:54 +02:00
- cmus (Default music player)
- neovim (Text editor)
2022-08-23 16:35:54 +02:00
- aerc (Email client)
- maim (Screenshot tool, automatically copies to clipboard using xclip)
- vifm (File manager)
- slock (Lock screen)
And everything under 'Features'.