added publishing metadata and seperated project readmes
Some checks failed
CI / Lint and Test (pull_request) Successful in 37s
CI / Version Check (pull_request) Failing after 3s

This commit is contained in:
2026-03-30 00:58:48 +02:00
parent de363276b2
commit ad8738e6dd
5 changed files with 187 additions and 19 deletions

View File

@@ -2,8 +2,15 @@
name = "stitch-peek"
version = "0.1.1"
edition = "2024"
description = "Nautilus thumbnail generator for PES embroidery files"
license = "MIT"
repository = "https://git.narl.io/nvrl/stitch-peek-rs"
authors = ["Nils Pukropp <nils@narl.io>"]
keywords = ["embroidery", "pes", "thumbnailer", "nautilus"]
categories = ["graphics", "command-line-utilities"]
readme = "README.md"
[dependencies]
rustitch = { path = "../rustitch" }
rustitch = { version = "0.1.1", path = "../rustitch" }
clap = { version = "4", features = ["derive"] }
anyhow = "1"

69
stitch-peek/README.md Normal file
View File

@@ -0,0 +1,69 @@
# stitch-peek
A CLI tool and **Nautilus/GNOME thumbnailer** for PES embroidery files. Generates PNG previews of embroidery designs directly in your file manager.
Part of the [stitch-peek-rs](https://git.narl.io/nvrl/stitch-peek-rs) project. Uses [rustitch](https://crates.io/crates/rustitch) for PES parsing and rendering.
## Installation
### From .deb (Debian/Ubuntu)
Download the latest `.deb` from the [Releases](https://git.narl.io/nvrl/stitch-peek-rs/releases) page:
```sh
sudo dpkg -i stitch-peek_*_amd64.deb
```
### From crates.io
```sh
cargo install stitch-peek
```
Then install the thumbnailer and MIME type files manually:
```sh
sudo install -Dm644 data/stitch-peek.thumbnailer /usr/share/thumbnailers/stitch-peek.thumbnailer
sudo install -Dm644 data/pes.xml /usr/share/mime/packages/pes.xml
sudo update-mime-database /usr/share/mime
```
### From source
```sh
git clone https://git.narl.io/nvrl/stitch-peek-rs.git
cd stitch-peek-rs
cargo install --path stitch-peek
```
After installing, restart Nautilus to pick up the thumbnailer:
```sh
nautilus -q
```
## Usage
### As a thumbnailer
Once installed with the `.thumbnailer` file in place, Nautilus automatically generates thumbnails for `.pes` files. No manual action needed.
### Standalone CLI
```sh
stitch-peek -i design.pes -o preview.png -s 256
```
| Flag | Description | Default |
|------|-------------|---------|
| `-i` | Input PES file | required |
| `-o` | Output PNG path | required |
| `-s` | Thumbnail size (pixels) | 128 |
## How it works
The tool follows the [freedesktop thumbnail specification](https://specifications.freedesktop.org/thumbnail/latest/). Nautilus calls it with an input file, output path, and requested size. It parses the PES file, renders the stitch pattern as anti-aliased colored lines on a transparent background, and writes a PNG.
## License
MIT