Skip to content

Commit

Permalink
docs: Update README and config documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pdf committed Mar 6, 2024
1 parent 8af7d79 commit 3846f7a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 19 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ An opinionated panel/shell for the Hyprland compositor.
## Install

TODO: Binary releases and documentation

### Dependencies

This project depends on (required):
Expand All @@ -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):

Expand All @@ -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

Expand Down
16 changes: 8 additions & 8 deletions proto/hyprpanel/config/v1/config.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions proto/hyprpanel/config/v1/config.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 {
Expand Down

0 comments on commit 3846f7a

Please sign in to comment.