Repository files navigation

Read books in style.

• gjs (>= 1.76)
• gtk4 (>= 4.12)
• libadwaita (>= 1.4;gir1.2-adw-1 in Debian-based distros)
• webkitgtk-6.0 (webkitgtk6.0 in Fedora;gir1.2-webkit-6.0 in Debian-based distros)

To enable auto-hyphenation, you will need to install hyphenation rules, e.g.,hyphen-en for English,hyphen-fr for French, etc. (which strictly speaking are optional dependencies for WebkitGTK, not Foliate itself).

For text-to-speech support, installspeech-dispatcher and output modules such asespeak-ng.

If installed,tracker (>= 3;gir1.2-tracker-3.0 in Debian-based distros) andtracker-miners can be used to track the locations of files.

The repo uses git submodules. Before running or installing, make sure you clone the whole thing with--recurse-submodules:

git clone --recurse-submodules https://github.com/johnfactotum/foliate.git

Or download the tarball (the.tar.xz file) from theReleases page.

It's possible to run directly from the source tree without building or installing. Simply run

gjs -m src/main.js

This can be useful if you just want to quickly try out Foliate or test a change.

But note that this will run it without using GSettings, so settings will not be saved. To solve this, you can compile the schema by running

glib-compile-schemas data

Then you can set the schema directory when running the app:

GSETTINGS_SCHEMA_DIR=data gjs -m src/main.js

The following dependencies are required for building:

• meson (>= 0.59)
• pkg-config
• gettext

To install, run the following commands:

meson setup buildsudo ninja -C build install

To uninstall, run

sudo ninja -C build uninstall

By default Meson installs to/usr/local. You can install without root permissions by choosing a local prefix, such as$PWD/run:

meson setup build --prefix $PWD/runninja -C build install

You can then run it with

GSETTINGS_SCHEMA_DIR=run/share/glib-2.0/schemas ./run/bin/foliate

Foliate is available onFlathub.

For developement with Flatpak, useGNOME Builder to open and run the project.

Foliate is available on theSnap Store. To install:

sudo snap install foliate

This program is free software: you can redistribute it and/or modify it under the terms of theGNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The following JavaScript libraries are bundled in this software:

• foliate-js, which is MIT licensed.
• zip.js, which is licensed under the BSD-3-Clause license.
• fflate, which is MIT licensed.
• PDF.js, which is licensed under Apache License 2.0.