From d9f386e7db25f905a73ba41afb88777b803ddf08 Mon Sep 17 00:00:00 2001 From: Jacob Date: Mon, 2 Jan 2023 18:38:48 +0100 Subject: [PATCH] Add better documentation of compilation dependencies Fixes #221 --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 47eb7bde..c1b3a22d 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,20 @@ any contributions or feedback for the project. ## Dependencies +### Compiling + +Compiling requires the same dependencies as Fyne. See the [Getting Started](https://developer.fyne.io/started/) documentation for installation steps. + +### Running + For a full desktop experience you will also need the following external tools installed: -- `arandr` +- `arandr` for modifying display settings - `xbacklight` or `brightnessctl` for laptop brightness - `connman-gtk` is currently used for configuring Wi-Fi network settings +- `compton` for compositor support -Compositor support currently requires `compton` to be installed. +The desktop does work without the runtime dependencies but the experience will be degraded. ## Getting Started