README.md 1.7 KB

Packaging scripts

libvips and its dependencies are provided as pre-compiled shared libraries for the most common operating systems and CPU architectures.

During npm install, these binaries are fetched as tarballs from this repository via HTTPS and stored locally within node_modules/sharp/vendor.

The base URL can be overridden using the npm_config_sharp_libvips_binary_host environment variable.

https://sharp.pixelplumbing.com/install#custom-prebuilt-binaries

Creating a tarball

Most people will not need to do this; proceed with caution.

Run the top-level build script without parameters for help.

Linux

One build script is used to (cross-)compile the same shared libraries within multiple containers.

Windows

The output of libvips' build-win64-mxe "web" target is post-processed within multiple containers.

macOS

Uses a macOS virtual machine hosted by GitHub to compile the shared libraries. The dylib files are compiled within the same build script as Linux.

Depedency paths are modified to be the relative @rpath using install_name_tool.

Licences

These scripts are licensed under the terms of the Apache 2.0 Licence.

The shared libraries contained in the tarballs are distributed under the terms of various licences, all of which are compatible with the Apache 2.0 Licence.