diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 55 |
1 files changed, 37 insertions, 18 deletions
diff --git a/README.adoc b/README.adoc index 218ba82..9ca9e65 100644 --- a/README.adoc +++ b/README.adoc @@ -2,7 +2,7 @@ fiv === 'fiv' is a slightly unconventional, general-purpose image browser and viewer -for Linux (that said, macOS and Windows ports are possible). +for Linux and Windows (macOS still has major issues). image::docs/fiv.webp["Screenshot of both the browser and the viewer"] @@ -13,7 +13,7 @@ Features photos, HEIC, AVIF, SVG, X11 cursors and TIFF, or whatever your gdk-pixbuf modules manage to load. - Employs high-performance file format libraries: Wuffs and libjpeg-turbo. - - Makes use of 30-bit X.org visuals, whenever it's possible and appropriate. + - Can make use of 30-bit X.org visuals, under certain conditions. - Has a notion of pages, and tries to load all included content within files. - Can keep the zoom and position when browsing, to help with comparing zoomed-in images. @@ -33,41 +33,60 @@ Not necessarily in this order. Packages -------- -Regular releases are sporadic. git master should be stable enough. You can get -a package with the latest development version from Archlinux's AUR. +Regular releases are sporadic. git master should be stable enough. +You can get a package with the latest development version using Arch Linux's +https://aur.archlinux.org/packages/fiv-git[AUR], +or as a https://git.janouch.name/p/nixexprs[Nix derivation]. Building and Running -------------------- -Build-only dependencies: Meson, pkg-config, asciidoctor or asciidoc + +Build-only dependencies: + Meson, pkg-config, asciidoctor or asciidoc (recommended but optional) + Runtime dependencies: gtk+-3.0, glib>=2.64, pixman-1, shared-mime-info, -libturbojpeg, libwebp + -Optional dependencies: lcms2, LibRaw, librsvg-2.0, xcursor, libheif, libtiff, -ExifTool, resvg (unstable API, needs to be requested explicitly) + libturbojpeg, libwebp, libepoxy, librsvg-2.0 (for icons) + +Optional dependencies: lcms2, Little CMS fast float plugin, + LibRaw, librsvg-2.0, xcursor, libheif, libtiff, ExifTool, + resvg (unstable API, needs to be requested explicitly) + +Runtime dependencies for reverse image search: + xdg-utils, cURL, jq $ git clone --recursive https://git.janouch.name/p/fiv.git - $ meson builddir + $ cd fiv + $ meson setup builddir $ cd builddir $ meson compile + $ meson devenv fiv -Considering the vast amount of dynamically-linked dependencies, do not attempt -direct installations via `ninja install`. To test the program: +The lossless JPEG cropper and reverse image search are intended to be invoked +from a file manager context menu. - $ meson devenv fiv +For proper integration, you will need to install the application. On Debian, +you can get a quick and dirty installation package for testing purposes using: -The lossless JPEG cropper is intended to be invoked from a context menu. + $ meson compile deb + # dpkg -i fiv-*.deb Windows ~~~~~~~ 'fiv' can be cross-compiled for Windows, provided that you install a bunch of -dependencies listed at the beginning of 'msys2-cross-configure.sh', -plus rsvg-convert from librsvg2, and icotool from icoutils. +dependencies listed at the beginning of 'msys2-configure.sh', +plus rsvg-convert from librsvg2, icotool from icoutils, and msitools ≥ 0.102. Beware that the build will take up about a gigabyte of disk space. - $ sh -e msys2-cross-configure.sh builddir - $ meson install -C builddir + $ sh -e msys2-configure.sh builddir + $ meson compile package -C builddir If everything succeeds, you will find a portable build of the application -in the 'builddir/package' subdirectory. Keep your expectations low. +in the 'builddir/package' subdirectory, and a very basic MSI installation +package in 'builddir'. + +Faster colour management +^^^^^^^^^^^^^^^^^^^^^^^^ +To get the Little CMS fast float plugin, you'll have to enter MSYS2 and +https://www.msys2.org/wiki/Creating-Packages/#re-building-a-package[rebuild] +_mingw-w64-lcms2_ with the following change: + + sed -i 's/meson setup /&-Dfastfloat=true /' PKGCONFIG Documentation ------------- |