speedwm-personal/docs/dependencies.md

## 5. 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.

- [spmenu](https://speedie.site/projects/spmenu.php)
  - As of speedwm 1.9, speedwm now expects spmenu (fork of dmenu) to be on the system instead of dmenu. While you can revert this change I cannot provide support due to missing arguments.
- 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`.

- speedwm-extras
  - Metapackage containing extra scripts that speedwm makes use of. (https://codeberg.org/speedie/speedwm-extras)
- libspeedwm
  - Dependency for speedwm-extras allowing you to perform actions externally.
- st - Default terminal
- Chromium - Default web browser

And everything under `Features`.
new documentation, rename lots of docs to add .md prefix 2023-01-25 16:29:53 +01:00			`## 5. Dependencies`
Go through with an issue, separate scripts and cleanup 2022-10-27 17:41:42 +02:00
few updates 2023-01-18 16:06:58 +01:00			`### Required`

Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`These are absolutely necessary, speedwm will NOT compile without them`
			`- libxft`
few updates 2023-01-18 16:06:58 +01:00			`- Used for rendering text`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- pango`
few updates 2023-01-18 16:06:58 +01:00			`- Used to markup text`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- libXinerama`
few updates 2023-01-18 16:06:58 +01:00			`- Used for multi-monitor support.`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- Can be disabled through editing toggle.mk if you're not interested in multiple monitors.`
			`- imlib2`
few updates 2023-01-18 16:06:58 +01:00			`- Used for tag previews, window icons.`
			`- Can be disabled through editing toggle.mk and toggle.h if you don't want these features.`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- yajl`
few updates 2023-01-18 16:06:58 +01:00			`- 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.`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- tcc`
few updates 2023-01-18 16:06:58 +01:00			`- 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).`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00
few updates 2023-01-18 16:06:58 +01:00			`### Features`
Go through with an issue, separate scripts and cleanup 2022-10-27 17:41:42 +02:00
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`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.`
Go through with an issue, separate scripts and cleanup 2022-10-27 17:41:42 +02:00
.site 2023-04-14 19:27:08 +02:00			`- [spmenu](https://speedie.site/projects/spmenu.php)`
remove most spawn() keybinds, old (personal) config available at https://codeberg.org/speedie/dotfiles 2023-01-29 17:01:27 +01:00			`- As of speedwm 1.9, speedwm now expects spmenu (fork of dmenu) to be on the system instead of dmenu. While you can revert this change I cannot provide support due to missing arguments.`
few updates 2023-01-18 16:06:58 +01:00			`- 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`.
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00
remove most spawn() keybinds, old (personal) config available at https://codeberg.org/speedie/dotfiles 2023-01-29 17:01:27 +01:00			`- speedwm-extras`
			`- Metapackage containing extra scripts that speedwm makes use of. (https://codeberg.org/speedie/speedwm-extras)`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- libspeedwm`
few updates 2023-01-18 16:06:58 +01:00			`- Dependency for speedwm-extras allowing you to perform actions externally.`
			`- st - Default terminal`
			`- Chromium - Default web browser`

			And everything under `Features`.
update documentation 2023-02-03 16:52:17 +01:00