From 477089435a24cb157f3ecfed278223e348509772 Mon Sep 17 00:00:00 2001 From: Bono Fox Date: Thu, 20 Nov 2025 00:31:58 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Updated=20developer=20documentat?= =?UTF-8?q?ion?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - added required features to command - guide to run the CLI as a developer --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0666073..ede6a9e 100644 --- a/README.md +++ b/README.md @@ -100,10 +100,9 @@ The UI is available in two variants: Via the terminal, you can open it by setting the flag: `tiny4linux-gui --start-as widget` | Dashboard Mode | Widget Mode | -|----------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | Dashboard Mode | Widget Mode | - ### CLI You can use the CLI by typing `t4l` or `tiny4linux-cli` in your terminal. @@ -118,12 +117,24 @@ Therefore, using a VM — for example, via [VirtualBox](https://wiki.archlinux.o Once you’ve set the color values, gesture settings, and preset camera positions once, there’s no need to start the VM regularly anymore. The rest is what this program is meant to handle ;) -## Run the GUI (for devs) +## Run the Application (for devs) + +### GUI -To run the GUI, you have to build the project and then run the binary: +To run the GUI, you have to build the project and then run the corresponding binary. +Remember to enable the `gui` feature: ```shell -cargo run --package tiny4linux --bin tiny4linux-gui +cargo run --package tiny4linux --bin tiny4linux-gui --features="gui" ``` -With _Jetbrains RustRover_, you can directly execute the corresponding Run Configuration. +With _Jetbrains RustRover_, you can directly execute the Run Configuration. + +### CLI + +To run the CLI, you have to build the project and then run the corresponding binary. +Remember to enable the `cli` feature: + +```shell +cargo run --package tiny4linux --bin tiny4linux-cli --features="cli" +```