##// END OF EJS Templates
Update README.md
Tsuki -
r2:25a6280c96ec default
parent child Browse files
Show More
@@ -1,58 +1,58
1 1 ## Swindle
2 2
3 3
4 4
5 5 > "It's so bad it's not even funny!" -kantiankant, 2026
6 6
7 7
8 8 Swindle is a fork of [dwl](https://codeberg.org/dwl/dwl) that was designed from the start with one goal: to make it feel like the poor man's Hyprland. It has the following:
9 9
10 10 * NO cool vfx
11 11 * nearly NO documentation
12 12 * ZERO good original code
13 13 * only ONE tiling layout (dwindle)
14 14
15 15 > Fun fact: I actually took some parts of [MangoWM](https://github.com/mangowm/mango) (such as the ext-workspaces implementation). hence why the LICENSE.mangowm exists
16 16
17 17 ## Dependencies
18 18
19 19 * libinput
20 20 * wayland
21 21 * wlroots-0.20 (compiled with the libinput backend)
22 22 * xkbcommon
23 23 * wayland-protocols (compile-time only)
24 24 * pkg-config (compile-time only)
25 25 * meson (compile-time only)
26 26 * ninja (compile-time only)
27 27
28 28 Install these (and their `-devel` versions if your distro has separate
29 development packages) and run `make` followed by `doas/sudo make install`, if you wish to install it (installs to /usr/local/bin/ by default).
29 development packages) and run `meson setup build` followed by `doas/sudo ninja -C build install`, if you wish to install it (installs to /usr/local/bin/ by default).
30 30
31 31 ## Things that are good to have
32 32
33 33 * [foot](https://codeberg.org/dnkl/foot)
34 34
35 35
36 36 ## Known Issues
37 37
38 38 N/A
39 39
40 40 ## Configuration
41 41
42 42 read example/config.lua. It should give you a basic idea of how configuring swindle works.
43 43
44 44 > note: it's best to copy /etc/swindle/config.lua into XDG_HOME_DIR/.config/swindle/ before you attempt to
45 45 start swindle because it (swindle) won't start without it
46 46
47 47 ## Checklist
48 48
49 49 - [ ] separate the trackpad scroll from the mousee scroll
50 50 - [x] Add ability to change your keymap
51 51 - [ ] Add animations via [scenefx](https://github.com/wlrfx/scenefx) when 0.5 drops (in another branch)
52 52 - [ ] Add the ability for the compositor to read a custom path for configs
53 53 - [ ] Add /etc/swindle/config.lua as a fallback path if $HOME/.config/swindle/config.lua is not found
54 54
55 55
56 56 ## License
57 57
58 58 GPL-v3, probably
General Comments 0
You need to be logged in to leave comments. Login now