diff --git a/README.md b/README.md index 718fd3d..09c1824 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ An opinionated panel/shell for the Hyprland compositor. ## Install -TODO: Binary releases and documentation - ### Dependencies This project depends on (required): @@ -25,7 +23,13 @@ Optional dependencies (required for default configuration): Please ensure that you have these packages installed. -### Install from source +### Install from Release + +Download the [latest release](https://github.com/pdf/hyprpanel/releases/latest) for your operating system and architecture. + +Unpack the archive and place the `hyprpanel` and `hyprpanel-client` binaries on your `$PATH`. + +### Install from Source Execute the following (requires the Go toolchain): @@ -52,7 +56,7 @@ You may review the current default configuration at [config/default.json](config JSON is not my first choice for a human-writable config format, but due to internal protobuf usage this was by far the least painful format to implement. -TODO: Link config documentation here +For details on the configuration options, please see the [Configuration Reference](https://github.com/pdf/hyprpanel/wiki/Config) in the wiki. ## Panels diff --git a/proto/hyprpanel/config/v1/config.pb.go b/proto/hyprpanel/config/v1/config.pb.go index 2fb11f2..7113364 100644 --- a/proto/hyprpanel/config/v1/config.pb.go +++ b/proto/hyprpanel/config/v1/config.pb.go @@ -307,8 +307,8 @@ type Config_DBUS struct { Notifications *Config_DBUS_Notifications `protobuf:"bytes,4,opt,name=notifications,proto3" json:"notifications,omitempty"` // notifications configuration. Systray *Config_DBUS_Systray `protobuf:"bytes,5,opt,name=systray,proto3" json:"systray,omitempty"` // systray configuration. Shortcuts *Config_DBUS_Shortcuts `protobuf:"bytes,6,opt,name=shortcuts,proto3" json:"shortcuts,omitempty"` // shortcuts configuration. - Brightness *Config_DBUS_Brightness `protobuf:"bytes,7,opt,name=brightness,proto3" json:"brightness,omitempty"` - Power *Config_DBUS_Power `protobuf:"bytes,8,opt,name=power,proto3" json:"power,omitempty"` + Brightness *Config_DBUS_Brightness `protobuf:"bytes,7,opt,name=brightness,proto3" json:"brightness,omitempty"` // brightness configuration. + Power *Config_DBUS_Power `protobuf:"bytes,8,opt,name=power,proto3" json:"power,omitempty"` // power configuration. } func (x *Config_DBUS) Reset() { @@ -695,12 +695,12 @@ type Config_DBUS_Power struct { sizeCache protoimpl.SizeCache unknownFields protoimpl.UnknownFields - Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"` // enables power functionality. - LowPercent uint32 `protobuf:"varint,2,opt,name=low_percent,json=lowPercent,proto3" json:"low_percent,omitempty"` - CriticalPercent uint32 `protobuf:"varint,3,opt,name=critical_percent,json=criticalPercent,proto3" json:"critical_percent,omitempty"` - LowCommand string `protobuf:"bytes,4,opt,name=low_command,json=lowCommand,proto3" json:"low_command,omitempty"` - CriticalCommand string `protobuf:"bytes,5,opt,name=critical_command,json=criticalCommand,proto3" json:"critical_command,omitempty"` - HudNotifications bool `protobuf:"varint,6,opt,name=hud_notifications,json=hudNotifications,proto3" json:"hud_notifications,omitempty"` + Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"` // enables power functionality. + LowPercent uint32 `protobuf:"varint,2,opt,name=low_percent,json=lowPercent,proto3" json:"low_percent,omitempty"` // percentage below which we should consider low power. + CriticalPercent uint32 `protobuf:"varint,3,opt,name=critical_percent,json=criticalPercent,proto3" json:"critical_percent,omitempty"` // percentage below which we should consider critical power. + LowCommand string `protobuf:"bytes,4,opt,name=low_command,json=lowCommand,proto3" json:"low_command,omitempty"` // command to execute on low power. + CriticalCommand string `protobuf:"bytes,5,opt,name=critical_command,json=criticalCommand,proto3" json:"critical_command,omitempty"` // command to execute on critical power. + HudNotifications bool `protobuf:"varint,6,opt,name=hud_notifications,json=hudNotifications,proto3" json:"hud_notifications,omitempty"` // display HUD notifications on power state change or low power. } func (x *Config_DBUS_Power) Reset() { diff --git a/proto/hyprpanel/config/v1/config.proto b/proto/hyprpanel/config/v1/config.proto index 39694d7..9456f5e 100644 --- a/proto/hyprpanel/config/v1/config.proto +++ b/proto/hyprpanel/config/v1/config.proto @@ -55,11 +55,11 @@ message Config { message Power { bool enabled = 1; // enables power functionality. - uint32 low_percent = 2; - uint32 critical_percent = 3; - string low_command = 4; - string critical_command = 5; - bool hud_notifications = 6; + uint32 low_percent = 2; // percentage below which we should consider low power. + uint32 critical_percent = 3; // percentage below which we should consider critical power. + string low_command = 4; // command to execute on low power. + string critical_command = 5; // command to execute on critical power. + bool hud_notifications = 6; // display HUD notifications on power state change or low power. } bool enabled = 1; // if false, no DBUS functionality is available. @@ -69,8 +69,8 @@ message Config { Notifications notifications = 4; // notifications configuration. Systray systray = 5; // systray configuration. Shortcuts shortcuts = 6; // shortcuts configuration. - Brightness brightness = 7; - Power power = 8; + Brightness brightness = 7; // brightness configuration. + Power power = 8; // power configuration. } message Audio {