diff --git a/README.md b/README.md index 4bc976d..596962b 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,42 @@ # Aylur's Gtk Shell -A customizable shell for Hyprland. -The goal of this project is to be something like [EWW](https://github.com/elkowar/eww), but offer predifined components instead of barebones widgets, so that you don't have to build your desktop from scratch, but still have the option to build custom components. +This is basically a toolkit I wrote so that I can declaratively define Gtk widgets in javascript. +The goal of this project is to be something like [EWW](https://github.com/elkowar/eww), but offer predifined components instead of barebone widgets, so that you don't have to build your desktop from scratch, but still have the option to build custom components. + +I will make a wiki, but for now if you want to try it out your only documentation is the source code. + +## Install + +```bash +# dependencies +# Arch +yay -S gjs gtk3 socat gnome-bluetooth-3.0 upower networkmanager +# Fedora +sudo dnf install gjs gtk3 socat gnome-bluetooth upower NetworkManager +# build and install +meson setup build +meson install -C build +``` ## Plans -- [ ] Support other WMs - [ ] Lockscreen - [ ] Display manager (maybe?) ### Widgets - Basics: - - [ ] CircularProgress - - [ ] ProgressBar - [x] Box - [x] Button - [x] CenterBox + - [ ] CircularProgress - [x] Dynamic - [x] Entry - [x] EventBox - [x] Icon - [x] Label + - [x] Overlay + - [ ] ProgressBar - [x] Revealer - [x] Scrollable - [x] Slider @@ -30,7 +45,7 @@ The goal of this project is to be something like [EWW](https://github.com/elkowa - [x] Indicator - [x] Speaker Slider - [x] Mic mute toggle - - [ ] Applications Mixer + - [x] Applications Mixer - [x] Battery - Bluetooth - [x] Indicator @@ -41,6 +56,7 @@ The goal of this project is to be something like [EWW](https://github.com/elkowa - [x] Workspaces - [x] Active client indicator - [x] Taskbar + - [ ] Overview - [x] Mpris - Network - [x] SSID label @@ -50,11 +66,3 @@ The goal of this project is to be something like [EWW](https://github.com/elkowa - [ ] Connections - [x] Notifications - [ ] Tray - -# TODO - -- [ ] Wiki -- DBus client - - [x] run-js - - [x] toggle-window - - [x] inspector