From a8f740bf59307a00d53f038fe17ddd20d087642a Mon Sep 17 00:00:00 2001 From: Joachim Date: Sun, 4 May 2025 15:51:43 +0200 Subject: [PATCH] Actualiser README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 94bf229..2f43d74 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ -# RgbKeyboard +# Bash Breath animation -A small bash/python script to add smooth transitions between a set of colors on RGB keyboards, resulting in a "breath" animation. \ No newline at end of file +A small bash/python script to add smooth transitions between a set of colors on RGB keyboards, resulting in a "breath" animation. + +You can define the speed and colors with the `steps` and `colors` variables. + +As it uses directly the led system class, it need to be run as root. + +The python script will be placed at `/var/rgb.py` and a cron task will be automatically created to start the script at boot time. \ No newline at end of file