Skip to content

Commit

Permalink
chore: Add dependencies section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
danyspin97 committed Nov 29, 2024
1 parent 93503f2 commit e1cfd2d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ one tool, making it possible to use as interface for other tools like window man
- Supports for relative increase/decreases
- Designed to be fast

## Dependencies

**lumactl** doesn't have any build time dependency, other than a working Rust compiler and
toolchain. At runtime, it uses [_wmctl_](https://github.com/danyspin97/wmctl) to get the current
available displays, if the display argument hasn't been passed to it. _wmctl_ currently only
supports Wayland, but **lumactl** works with any display as long as you hard-code its name (i.e.
`DP-4`, `eDP-1` or `HDMI-A-1`, refer to your current window manager documentation on how
to get the mentioned information).

## Getting started

To build **lumactl** local, run:
Expand Down

0 comments on commit e1cfd2d

Please sign in to comment.