summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBabymusk <[email protected]>2024-02-15 02:27:51 +0000
committerGitHub <[email protected]>2024-02-14 21:27:51 -0500
commitcf3ef50a3fb8bf6d8b63d84d15cfdf0ae72daedb (patch)
tree57ea5c3127b6879cb827ed062543990c843fb1ac
parentf0ecffe593574593ec99c104fa12e4bfd593b0f2 (diff)
Added guide for Debian users (#268)
* Create INSTALL-deb * Rename INSTALL-deb to INSTALL-deb.md * Update README.md to include debian * Added a guide * Update README.md * Update INSTALL-deb.md * Version change
-rw-r--r--INSTALL-deb.md49
-rw-r--r--README.md3
2 files changed, 52 insertions, 0 deletions
diff --git a/INSTALL-deb.md b/INSTALL-deb.md
new file mode 100644
index 00000000..63e261cb
--- /dev/null
+++ b/INSTALL-deb.md
@@ -0,0 +1,49 @@
+## A guide to installing swayfx on Debian
+( You may have to adapt this guide to install on other distros )
+
+### First install all required dependencies and download the source code
+
+```bash
+sudo apt install meson wayland-protocols wayland libpcre2-dev libjson-c-dev libpango-1.0-0 libcairo2-dev wget
+```
+
+### Next setup the build enviroment
+```bash
+mkdir ~/build
+cd ~/build # Or whatever you have named it
+# Downloading Wlroots
+wget https://gitlab.freedesktop.org/wlroots/wlroots/-/archive/0.16.2/wlroots-0.16.2.tar.gz
+tar -xf wlroots-0.16.2.tar.gz
+rm wlroots-0.16.2.tar.gz
+
+# Downloaing Swayfx
+wget https://github.com/WillPower3309/swayfx/archive/refs/tags/0.3.2.tar.gz
+tar -xf 0.3.2.tar.gz
+rm 0.3.2.tar.gz
+```
+swayfx and wlroots should now be located in the `build` directory.
+```
+.
+├── swayfx-0.3.2
+├── wlroots-0.16.2
+```
+___
+### Compiling
+You MUST compile wlroots first.
+```bash
+cd wlroots-0.16.2
+meson setup build/
+ninja -C build/
+```
+
+Now to compile swayfx.
+```bash
+cd swayfx-0.3.2
+meson build/
+ninja -C build/
+sudo ninja -C build/ install
+```
+Reboot and then add the desired effects in your ~/.config/sway/config file <br/>
+e.g. `blur enable|disable`
+
++ Guide created with ♥️ by babymusk
diff --git a/README.md b/README.md
index 01a777da..e5b467ef 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,9 @@ You can also bring up a development shell and follow the build instructions belo
```
nix develop
```
+### Debian
+Check [INSTALL-deb.md](/INSTALL-deb.md)
+
### Manual Steps