diff --git a/README.md b/README.md index ac32a5f..95b16ce 100644 --- a/README.md +++ b/README.md @@ -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.