Update README

This commit is contained in:
Ottatop 2023-07-12 21:48:47 -05:00 committed by Ottatop
parent 91e9e77ff3
commit 21272c4530

View file

@ -18,10 +18,10 @@ Cool stuff happens on the dev branch sometimes, check it out!
- [x] Udev backend
- This is currently just a copy of Anvil's udev backend.
- [x] Basic tags
- Tags are currently very jank on the udev backend with multiple monitors. If you're checking udev out, I suggest unplugging all but one monitor or just using the winit backend until I flesh out the tag system.
- [ ] Widget system
- [ ] Layout system
- [ ] Server-side decorations
- [ ] Animations and blur and all that pizazz
- [ ] The other stuff Awesome has
- [ ] XWayland support
- [ ] Layer-shell support
@ -38,15 +38,18 @@ So, this is my attempt at making an Awesome-esque Wayland compositor.
## Dependencies
You'll need the following packages, as specified by [Smithay](https://github.com/Smithay/smithay):
```
libwayland
libxkbcommon
libudev
libinput
libgdm
libseat
```
Package names will vary across distros. TODO: list those names.
`libwayland libxkbcommon libudev libinput libgdm libseat`
- Arch:
```
sudo pacman -S wayland libxkbcommon systemd-libs libinput libgdm seatd
```
- Debian:
```
sudo apt install libwayland-dev libxkbcommon-dev libudev-dev libinput-dev libgdm-dev libseat-dev
```
- TODO: other distros.
You'll also need Lua 5.4 for configuration.
## Building
Build the project with:
@ -72,7 +75,7 @@ cargo run [--release] -- --<backend>
- `udev`: run Pinnacle in a tty. NOTE: I tried running udev in Awesome and some things broke so uh, don't do that
## Configuration
Please note: this is VERY WIP and has basically no options yet.
Please note: this is VERY WIP and has few options.
Pinnacle supports configuration through Lua (and hopefully more languages if it's not too unwieldy :crab:).