From 53aae18706fa0af410c31abbd8186f251e130e56 Mon Sep 17 00:00:00 2001 From: CalfMoon Date: Wed, 1 May 2024 15:50:51 +0545 Subject: [PATCH] doc: update readme updated readme to include install/usage guide, requirements and theme list --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e69de29..457109c 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,19 @@ +# Signal Desktop Themer +A script for injecting theme into [signal-desktop](https://github.com/signalapp/Signal-Desktop). +## Requirements +- python +- python-pip +- pipx +## Installation/Usage +**Note: Running this script requires sudo permission in linux. If you are unsure about this, the script is only a few lines and you can go thorough it really quickly.** +1. Install applications in requirements section if you don't have them. (search online if you don't know how) +2. Install this script with `pipx install signal-themer` +3. Run `sudo signal-themer ` in linux and `signal-themer ` in windows. +4. Launch Signal and enjoy! +## Removal +Currently there is no 'clean' way to remove the theme but it might be added in the future. +For now, create an empty css file and use that as theme. +## Theme List +- [whatsapp](https://github.com/CapnSparrow/signal-desktop-themes) +- [yuri and zero two](https://github.com/Foxunderground0/Signal-Themes) +- [catppuccin](https://github.com/CalfMoon/signal-desktop)