feat: add search pre-fills, fuzzy sorting, GPL license, and installer script

2026-08-05 23:28:11 -04:00
parent def7156b00
commit 6948893711
11 changed files with 963 additions and 20 deletions
@@ -11,12 +11,36 @@ 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, automatically prioritizing the highest-resolution version of each icon. 
+icon's path, automatically prioritizing the highest-resolution version of each icon.
+When the app first starts, the icon picker search bar is pre-filled with "folder.svg" (and the emblem picker is pre-filled with "symbolic") to direct users to the most common combinations this tool is used for.
+
 Selecting an icon (or passing one directly) opens the color editor:
+
 - **Color Editing**: Click a swatch to pick a new color for that `ColorScheme-*` class.
 - **Emblem Support**: Click "Add Emblem" to overlay another SVG on top of your background icon. You can drag to position it visually, or use sliders to adjust its X, Y, and Size. The tool automatically namespaces the emblem's CSS so you can color its layers independently from the background.
 - **Saving**: Source files are preserved. Modifications are kept in memory until you use the "Save As..." button to export a new SVG. Unsaved changes are protected by a confirmation prompt if you try to exit. Undo/Redo are available from the toolbar.

+## Requirements
+
+- **GTK4 Backend**: Required for the graphical interface to function (most Linux desktop users will already have this installed).
+- **Git**: Required on the system `PATH` if the tool needs to automatically clone the Breeze icon repository on its first run.
+
+## Installation
+
+The easiest way to install is using the provided install script, which will download the latest binary and place it in your path:
+
+```sh
+curl -sL https://git.rootiest.dev/rootiest/icon-color-tool/raw/branch/main/install.sh | bash
+```
+
+*(If you want to build from source instead, you can append ` -s -- --build` to the command above).*
+
+Alternatively, you can manually download the pre-built `amd64` binary from the [latest release](https://git.rootiest.dev/rootiest/icon-color-tool/releases/latest). 
+
+> [!NOTE]
+
+> Currently this tool is only available for `amd64` Linux systems.
+
 ## Configuration

 On first run, a config file is created at
@@ -45,3 +69,5 @@ installed system-wide (e.g. `gtk4-devel`/`libgtk-4-dev` and
 cargo build --release
 ./target/release/icon-color-tool
 ```
+
+#