lukaj 0.1.1 - Docs.rs

lukaj-0.1.1 is not a library.

Visit the last successful build: lukaj-0.2.0

Interactive diff tool for SVG images.

Features

Swipe SVG graphics comparison with zoom and drag support.

Installation

If you're a Rust programmer, lukaj can be installed with cargo. It supports two graphics backends which are enabled/disabled with cargo features.

Feature name	SVG library	2D rendering library
`use-rsvg` (default)	librsvg	cairo
`use-usvg`	resvg	tiny-skia

Depending on the operating system and selected feature set, lukaj will require additional development libraries.

When using default feature or both (with cargo --all-features):

$ sudo apt-get install build-essential libcairo2-dev libgdk-pixbuf-2.0-dev \
    libglib2.0-dev libpango1.0-dev libsdl2-dev libxml2-dev
$ cargo install lukaj --all-features

When using only use-usvg feature:

$ sudo apt-get install libsdl2-dev
$ cargo install lukaj --no-default-features --features use-usvg

Install MSYS2 and run from it's terminal run:

For default feature or both:

$ pacman -S mingw-w64-x86_64-gtk4 mingw-w64-x86_64-gettext \
    mingw-w64-x86_64-libxml2 mingw-w64-x86_64-pkgconf \
    mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2

For use-usvg feature only:
```
$ pacman -S mingw-w64-x86_64-SDL2
```

Add mingw binaries path (C:\msys64\mingw64\bin) to system Path

Change default rust toolchain to stable-gnu

rustup toolchain install stable-gnu
rustup default stable-gnu

Run cargo install command

For default feature or both:
```
$ cargo install lukaj --all-features
```

For use-usvg feature only:

$ cargo install lukaj --no-default-features --features use-usvg

For different setups see this GUI development with Rust and GTK4 guide. When running with only use-usvg feature see Rust-SDL2 readme for different development options.

[!WARNING] Precompiled binaries or installation with package managers are not supported yet.

Usage

To compare two SVG files run:

$ lukaj [path 1] [path 2]

Lukaj uses following mouse/keyboard controls:

Button	Action
Left Click	Move diff separator
Right Click	Move images
Scroll	Zoom in and out
R	Reset images position
Esc	Exit

$ lukaj --help
Interactive diff tool for SVG images

Usage: lukaj [OPTIONS] [FILES]...

Arguments:
  [FILES]...  Files to compare

  Options:
    -s, --scale <VALUE>      Sets a scaling factor
    --backend <BACKEND>      Preferred backend [default: rsvg-with-cairo]
                             [possible values: rsvg-with-cairo, usvg-with-skia]
    -h, --help               Print help
    -V, --version            Print version

Git integration

Lukaj can be used as git difftool. To add git diff-svg custom command, copy and paste following sections to .gitconfig file:

[difftool "lukaj"]
    cmd = ~/.cargo/bin/lukaj $LOCAL $REMOTE
[alias]
    diff-svg = "difftool -t lukaj -y"

Other integrations

PCB visual diff with kicad-cli and lukaj