update docs fixes #4
This commit is contained in:
parent
bb3ff26161
commit
922ef0b42a
2 changed files with 34 additions and 3 deletions
3
.github/workflows/rust.yml
vendored
3
.github/workflows/rust.yml
vendored
|
@ -21,8 +21,7 @@ jobs:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
||||||
|
|
||||||
|
- name: Install ubuntu dependencies
|
||||||
- name: Install ubuntu dependcies
|
|
||||||
run: |
|
run: |
|
||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt install -y librust-gdk4-sys-dev \
|
sudo apt install -y librust-gdk4-sys-dev \
|
||||||
|
|
34
README.md
34
README.md
|
@ -63,6 +63,38 @@ Styling is **wofi-compatible** with enhanced GTK4 features! Customize every aspe
|
||||||
|
|
||||||
## ⚙️ Setup
|
## ⚙️ Setup
|
||||||
|
|
||||||
|
### ⚒️ Dependencies
|
||||||
|
|
||||||
|
* GTK4
|
||||||
|
* Wayland
|
||||||
|
* GTK4 layer shell
|
||||||
|
|
||||||
|
#### Arch
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo pacman -S gtk4 gtk4-layer-shell
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Ubuntu
|
||||||
|
Ubuntu does not ship gtk4-layer-shell in a supported version.
|
||||||
|
Therefore it must be build manually
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt install -y librust-gdk4-sys-dev \
|
||||||
|
libglib2.0-dev libgtk-layer-shell-dev libgtk-layer-shell0 gir1.2-gtklayershell-0.1 \
|
||||||
|
libgtk-4-dev gobject-introspection libgirepository1.0-dev gtk-doc-tools python3 valac \
|
||||||
|
git cmake gcc meson ninja-build
|
||||||
|
|
||||||
|
cd /tmp
|
||||||
|
git clone https://github.com/wmww/gtk4-layer-shell
|
||||||
|
cd gtk4-layer-shell
|
||||||
|
meson setup -Dexamples=true -Ddocs=true -Dtests=true build
|
||||||
|
ninja -C build
|
||||||
|
sudo ninja -C build install
|
||||||
|
sudo ldconfig
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### 🌊 Hyprland Integration
|
### 🌊 Hyprland Integration
|
||||||
|
|
||||||
Enable beautiful blur effects for Worf:
|
Enable beautiful blur effects for Worf:
|
||||||
|
@ -75,7 +107,7 @@ layerrule = blur, worf
|
||||||
|
|
||||||
## 📚 Library Usage
|
## 📚 Library Usage
|
||||||
|
|
||||||
🔧 **Developer-Friendly**: Worf's launcher and UI components are available as a separate crate for building custom launchers.
|
🔧 **Developer-Friendly**: Worfs launcher and UI components are available as a separate crate for building custom launchers.
|
||||||
|
|
||||||
> ⚠️ **Note**: The library API is currently in development and not yet available on crates.io.
|
> ⚠️ **Note**: The library API is currently in development and not yet available on crates.io.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue