pogmommy/worf
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add build instructions

Browse source 
solves #98
This commit is contained in:
Alexander Mohr 2025-08-01 21:08:14 +02:00
parent 0f440c565b
commit ff552eb843
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -94,6 +94,24 @@ sudo ninja -C build install
sudo ldconfig
```
#### Installing Worf
Worf is not yet available on crates.io, so it has to be build from scratch.
Fortunately this is easy.
This is described here https://rustup.rs/
Then the following commands
```bash
git clone https://github.com/alexmohr/worf
cd worf
cargo build --release
```
You will find all worf binaries, including the examples, in `./target/release`.
Copy the binaries you need into a path that is part of `$PATH`, for example `/usr/bin`.
Installing via cargo (once available) will put the binaries in `$HOME/.cargo/bin`.
### 🌊 Hyprland Integration
@ -105,6 +123,7 @@ layerrule = blur, worf
---
## 📚 Library Usage
🔧 **Developer-Friendly**: Worfs launcher and UI components are available as a separate crate for building custom launchers.