Skip to content

Commit

Permalink
readme: document a bit better how to build & install manually
Browse files Browse the repository at this point in the history
  • Loading branch information
maximbaz committed Feb 18, 2025
1 parent efc8db6 commit 5114531
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,17 @@ Use one of the available packages and methods below:
- Alpine Linux: [wluma](https://pkgs.alpinelinux.org/packages?name=wluma) (from Alpine Edge; it will be available in stable branches since Alpine v3.16)
- Arch Linux: [wluma](https://aur.archlinux.org/packages/wluma/) or [wluma-git](https://aur.archlinux.org/packages/wluma-git/)
- NixOS: [wluma](https://search.nixos.org/packages?channel=unstable&show=wluma&from=0&size=50&sort=relevance&type=packages&query=wluma)
- Build the app yourself using the instructions below and install it via `sudo make install`
- Build the app yourself using the instructions below and copy the resulting binary somewhere in your `$PATH`.
- optionally, grab the `wluma.service` if you want to run it as a systemd-service - it can be placed e.g. in `~/.config/systemd/user/`.
- you might need `90-wluma-backlight.rules` too, if you want to give `wluma` direct driver access for the fastest performance (see "Permissions" section below) - it can be placed e.g. in `/etc/udev/rules.d/`.

## Build

[![CI](https://github.com/maximbaz/wluma/actions/workflows/ci.yml/badge.svg)](https://github.com/maximbaz/wluma/actions/workflows/ci.yml)

If you want to build the app yourself, make sure you use latest stable Rust, otherwise you might get compilation errors! Using `rustup` is perhaps the easiest. Ubuntu needs the following dependencies: `sudo apt-get -y install v4l-utils libv4l-dev libudev-dev libvulkan-dev libdbus-1-dev`.

Then simply run `make build`.
Then simply run `carbo build --locked --release` and the binary will be placed into `./target/release/wluma`.

This comment has been minimized.

Copy link
@regenman

regenman Feb 18, 2025

Contributor

Do you mean cargo? :)

This comment has been minimized.

Copy link
@maximbaz

maximbaz Feb 18, 2025

Author Owner

thanks 🙈


## Permissions

Expand Down

0 comments on commit 5114531

Please sign in to comment.