speedwm-personal/docs/doc-02.md

## 2. Installation

In order to install this build of speedwm, all dependencies must be installed.
You can see 'Dependencies' for a list of all dependencies required and optionally recommended to use speedwm.

  - git clone https://git.speedie.site/speedwm
  - cd speedwm
  - make clean install
    - If any warnings/errors show up, fix it by installing the missing dependency.
  - If a .xinitrc is used, add `speedwm` to the end of the file. If you're using .xinit you can also just `startx /usr/bin/speedwm`.
    - If you do not have a .xinitrc, you can add autostart commands to the file ~/.config/speedwm/autostart.sh.
  - If a display manager is used, make sure it supports .desktop entries.
  - NOTE: `ly` is known to have issues with dwm and speedwm.

If you see a bar or at least a cursor, your X server is likely working.
If you do **not** see a cursor or a bar, and no keys seem to do anything, your X server is most likely not configured properly.
If you get sent back to the TTY, your X server is most likely not configured properly. In this case, see your distro's wiki page on how to set up X11.

Note that speedwm is not and will **never** be compatible with Wayland. I have no interest in ever supporting or developing for it. Please don't create any issues regarding Wayland support.

If you're having any issues on operating systems with the BSD kernel, or something like NixOS, please file a bug report here on Codeberg, or by emailing me.

If you have any questions, see the official [speedwm wiki](https://speedwm.speedie.site).
number them 2023-01-24 22:22:57 +01:00			`## 2. Installation`
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00
HUGE changes to codebase 2022-09-21 19:49:54 +02:00			`In order to install this build of speedwm, all dependencies must be installed.`
update documentation slightly, delete status before installing it so that the user doesn't have to remove it if he doesn't want to use my status bar anymore alt+tab now doesn't break the position of the windows, because windows are arranged on switcherend() due to arrange() call 2023-01-16 18:51:37 +01:00			`You can see 'Dependencies' for a list of all dependencies required and optionally recommended to use speedwm.`
HUGE changes to codebase 2022-09-21 19:49:54 +02:00
.site 2023-04-14 19:27:08 +02:00			`- git clone https://git.speedie.site/speedwm`
HUGE changes to codebase 2022-09-21 19:49:54 +02:00			`- cd speedwm`
			`- 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			`- If any warnings/errors show up, fix it by installing the missing dependency.`
update documentation 2023-02-03 16:52:17 +01:00			- If a .xinitrc is used, add `speedwm` to the end of the file. If you're using .xinit you can also just `startx /usr/bin/speedwm`.
Add man page, remove speedwm_run, remove patching capability because no one used it, rewrite docs 2022-11-25 20:38:44 +01:00			`- If you do not have a .xinitrc, you can add autostart commands to the file ~/.config/speedwm/autostart.sh.`
update documentation slightly, delete status before installing it so that the user doesn't have to remove it if he doesn't want to use my status bar anymore alt+tab now doesn't break the position of the windows, because windows are arranged on switcherend() due to arrange() call 2023-01-16 18:51:37 +01:00			`- If a display manager is used, make sure it supports .desktop entries.`
			- NOTE: `ly` is known to have issues with dwm and speedwm.

			`If you see a bar or at least a cursor, your X server is likely working.`
			`If you do not see a cursor or a bar, and no keys seem to do anything, your X server is most likely not configured properly.`
			`If you get sent back to the TTY, your X server is most likely not configured properly. In this case, see your distro's wiki page on how to set up X11.`

			`Note that speedwm is not and will never be compatible with Wayland. I have no interest in ever supporting or developing for it. Please don't create any issues regarding Wayland support.`

update documentation 2023-02-03 16:52:17 +01:00			`If you're having any issues on operating systems with the BSD kernel, or something like NixOS, please file a bug report here on Codeberg, or by emailing me.`

.site 2023-04-14 19:27:08 +02:00			`If you have any questions, see the official [speedwm wiki](https://speedwm.speedie.site).`
HUGE changes to codebase 2022-09-21 19:49:54 +02:00