Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
updated readme to include install/usage guide, requirements and theme list
  • Loading branch information
CalfMoon committed May 1, 2024
1 parent 0f093b1 commit 53aae18
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <path/to/theme.css>` in linux and `signal-themer <path\to\theme.css>` 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)

0 comments on commit 53aae18

Please sign in to comment.