chore: remove Python implementation, add README for Rust version
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
# icon-color-tool
|
||||
|
||||
A small GTK4 desktop app for editing the `ColorScheme-*` CSS colors
|
||||
embedded in [Breeze icon](https://github.com/KDE/breeze-icons) SVGs.
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
icon-color-tool # opens a searchable icon picker
|
||||
icon-color-tool path/to/icon.svg # opens directly in the color editor
|
||||
```
|
||||
|
||||
The picker's search box does a fuzzy (subsequence) match against each
|
||||
icon's path. Selecting an icon (or passing one directly) opens the color
|
||||
editor: click a swatch to pick a new color for that `ColorScheme-*` class;
|
||||
changes save to disk immediately, and Undo/Redo are available from the
|
||||
toolbar.
|
||||
|
||||
## Configuration
|
||||
|
||||
On first run, a config file is created at
|
||||
`~/.config/icon-color-tool/config.toml`:
|
||||
|
||||
```toml
|
||||
[settings]
|
||||
breeze_path = "~/.local/share/breeze-icons"
|
||||
```
|
||||
|
||||
If the configured `breeze_path` doesn't exist (or is empty), the
|
||||
[breeze-icons](https://github.com/KDE/breeze-icons) repository is cloned
|
||||
there automatically (shallow clone via `git`, which must be installed and
|
||||
on `PATH`).
|
||||
|
||||
Set the `BREEZE_ICONS_PATH` environment variable to override the
|
||||
configured path entirely (also auto-clones if missing).
|
||||
|
||||
## Building
|
||||
|
||||
Requires Rust (stable) and the GTK4 + librsvg development libraries
|
||||
installed system-wide (e.g. `gtk4-devel`/`libgtk-4-dev` and
|
||||
`librsvg2-devel`/`librsvg2-dev`, depending on your distro).
|
||||
|
||||
```sh
|
||||
cargo build --release
|
||||
./target/release/icon-color-tool
|
||||
```
|
||||
Reference in New Issue
Block a user