speedwm-personal/docs/dependencies
2023-01-18 16:06:58 +01:00

58 lines
2.1 KiB
Plaintext

## Dependencies
### Required
These are absolutely necessary, speedwm will NOT compile without them
- libxft
- Used for rendering text
- pango
- Used to markup text
- libXinerama
- Used for multi-monitor support.
- Can be disabled through editing toggle.mk if you're not interested in multiple monitors.
- imlib2
- Used for tag previews, window icons.
- Can be disabled through editing toggle.mk and toggle.h if you don't want these features.
- yajl
- Used to interact with speedwm through a sock.
- Required for the IPC patch. If the IPC patch is disabled through toggle.mk and toggle.h, you do not need this.
- tcc
- Very minimal C compiler that speedwm uses to greatly speed up compile times. If you do not want this dependency, edit host.mk and set CC to 'cc' (or what C99 compiler you prefer).
### Features
These are necessary for certain features and keybinds.
If you want to use an alternative, change it in options.h and/or keybinds.h and mouse.h.
- dmenu
- dmenu is required for many keybinds included with this build of speedwm. It is also recommended that your build supports grids (-g argument)
- xrdb
- xrdb is used for external speedwm configuration (ie. after compiling). It is **not** mandatory if you don't need this.
### Software
This build of speedwm comes with keybinds for software.
You can add, change and remove keybinds by editing `keybinds.h` and `mouse.h` and running `make clean install`.
- libspeedwm
- Dependency for speedwm-extras allowing you to perform actions externally.
- speedwm-extras
- Important metapackage containing extra scripts that speedwm makes use of. (https://codeberg.org/speedie/speedwm-extras)
- st - Default terminal
- Chromium - Default web browser
- htop - Status monitor
- sfeed - RSS reader
- rssread - RSS frontend
- cmus - Music player
- Default status bar also has support for moc/mocp (Music On Console)
- neovim - Text editor
- neomutt - Email client
- lf - File manager
- slock - Lock screen
- weechat - IRC client
- tmux - Used for the music player and IRC client
- j4-dmenu-desktop - Listing .desktop entries
And everything under `Features`.