From 11232c5cf10cbb1b6a66532e32eade36f442e0d7 Mon Sep 17 00:00:00 2001 From: Vaxry Date: Sat, 17 Feb 2024 19:33:44 +0000 Subject: [PATCH] readme: add config --- CMakeLists.txt | 2 +- README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 8c3db00..b6aa25f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,7 +32,7 @@ message(STATUS "Checking deps...") find_package(Threads REQUIRED) find_package(PkgConfig REQUIRED) -pkg_check_modules(deps REQUIRED IMPORTED_TARGET wayland-client wayland-protocols hyprlang>=0.3.2 sdbus-c++ tomlplusplus) +pkg_check_modules(deps REQUIRED IMPORTED_TARGET wayland-client wayland-protocols hyprlang>=0.3.2) file(GLOB_RECURSE SRCFILES CONFIGURE_DEPENDS "src/*.cpp") add_executable(hypridle ${SRCFILES}) diff --git a/README.md b/README.md index a263beb..c6ab166 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # hypridle Hyprland's idle daemon + +# Configuration + +Configuration is done via `~/.config/hypr/hypridle.conf` in the standard +hyprland syntax. + +```ini +listener { + timeout = 500 # in seconds + on-timeout = notify-send "You are idle!" # command to run when timeout has passed + on-resume = notify-send "Welcome back!" # command to run when activity is detected after timeout has fired. +} +``` + +# Dependencies + - wayland + - wayland-protocols + - hyprlang >= 0.4.0 \ No newline at end of file