base on Read e-books in style <img src="data/com.github.johnfactotum.Foliate.svg" align="left" style="margin-right:8px"> <br><br> # Foliate Read books in style. ![Screenshot](data/screenshots/screenshot.png) ## Installation ### Run Time Dependencies - `gjs` (>= 1.82) - `gtk4` (>= 4.12) - `libadwaita` (>= 1.8; `gir1.2-adw-1` in Debian-based distros) - `webkitgtk-6.0` (`webkitgtk6.0` in Fedora; `gir1.2-webkit-6.0` in Debian-based distros) #### Optional Dependencies 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, install `speech-dispatcher` and output modules such as `espeak-ng`. If installed, `tracker` (>= 3; `gir1.2-tracker-3.0` in Debian-based distros) and `tracker-miners` can be used to track the locations of files. ### Obtaining the Source 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 the [Releases](https://github.com/johnfactotum/foliate/releases) page. ### Run without Building or Installing 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 ``` ### Building and Installing from Source The following dependencies are required for building: - `meson` (>= 0.59) - `pkg-config` - `gettext` To install, run the following commands: ``` meson setup build sudo ninja -C build install ``` To uninstall, run ``` sudo ninja -C build uninstall ``` #### Installing to a Local Directory 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/run ninja -C build install ``` You can then run it with ``` GSETTINGS_SCHEMA_DIR=run/share/glib-2.0/schemas ./run/bin/foliate ``` ### Flatpak Foliate is available on [Flathub](https://flathub.org/apps/details/com.github.johnfactotum.Foliate). For developement with Flatpak, use [GNOME Builder](https://wiki.gnome.org/Apps/Builder) to open and run the project. ### Snap Foliate is available on the [Snap Store](https://snapcraft.io/foliate). To install: ``` sudo snap install foliate ``` ## Screenshots ![Dark mode](data/screenshots/dark.png) ![Wikipedia lookup](data/screenshots/lookup.png) ![Book metadata](data/screenshots/about.png) ![Annotations](data/screenshots/annotations.png) ![Popup footnote](data/screenshots/footnote.png) ![Vertical writing](data/screenshots/vertical.png) ## License This program is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) 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](https://github.com/johnfactotum/foliate-js), which is MIT licensed. - [zip.js](https://github.com/gildas-lormeau/zip.js), which is licensed under the BSD-3-Clause license. - [fflate](https://github.com/101arrowz/fflate), which is MIT licensed. - [PDF.js](https://github.com/mozilla/pdf.js), which is licensed under Apache License 2.0. --- <a href="https://www.buymeacoffee.com/johnfactotum" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a> ", Assign "at most 3 tags" to the expected json: {"id":"4961","tags":[]} "only from the tags list I provide: [{"id":39,"name":"3d-generation","display_name":"3D generation","slug":"3d-generation"},{"id":3,"name":"ai-agent","display_name":"AI agent","slug":"ai-agent"},{"id":8,"name":"ai-coding","display_name":"AI coding assistant","slug":"ai-coding"},{"id":5,"name":"ai-image","display_name":"AI image generation","slug":"ai-image"},{"id":9,"name":"ai-infrastructure","display_name":"AI infrastructure","slug":"ai-infrastructure"},{"id":10,"name":"ai-memory","display_name":"AI memory","slug":"ai-memory"},{"id":11,"name":"ai-skills","display_name":"AI skills","slug":"ai-skills"},{"id":12,"name":"ai-translation","display_name":"AI translation","slug":"ai-translation"},{"id":6,"name":"ai-video","display_name":"AI video generation","slug":"ai-video"},{"id":4,"name":"ai-voice","display_name":"AI voice","slug":"ai-voice"},{"id":7,"name":"ai-workflow","display_name":"AI workflow","slug":"ai-workflow"},{"id":22,"name":"audio-processing","display_name":"Audio processing","slug":"audio-processing"},{"id":29,"name":"authentication","display_name":"Authentication","slug":"authentication"},{"id":51,"name":"bundler","display_name":"Bundler","slug":"bundler"},{"id":41,"name":"chatbot","display_name":"Chatbot","slug":"chatbot"},{"id":27,"name":"cloud-native","display_name":"Cloud native","slug":"cloud-native"},{"id":1,"name":"computer-vision","display_name":"Computer vision","slug":"computer-vision"},{"id":37,"name":"crypto-trading","display_name":"Crypto trading","slug":"crypto-trading"},{"id":57,"name":"curated-list","display_name":"Curated list","slug":"curated-list"},{"id":54,"name":"data-streaming","display_name":"Data streaming","slug":"data-streaming"},{"id":35,"name":"data-visualization","display_name":"Data visualization","slug":"data-visualization"},{"id":16,"name":"database-backup","display_name":"Database backup","slug":"database-backup"},{"id":49,"name":"design-system","display_name":"Design system","slug":"design-system"},{"id":38,"name":"digital-human","display_name":"Digital human","slug":"digital-human"},{"id":34,"name":"document-processing","display_name":"Document processing","slug":"document-processing"},{"id":44,"name":"ecommerce","display_name":"E-commerce","slug":"ecommerce"},{"id":45,"name":"emulator","display_name":"Emulator","slug":"emulator"},{"id":46,"name":"file-management","display_name":"File management","slug":"file-management"},{"id":32,"name":"fintech","display_name":"Fintech","slug":"fintech"},{"id":31,"name":"game-development","display_name":"Game development","slug":"game-development"},{"id":24,"name":"headless-browser","display_name":"Headless browser","slug":"headless-browser"},{"id":52,"name":"headless-cms","display_name":"Headless CMS","slug":"headless-cms"},{"id":36,"name":"home-automation","display_name":"Home automation","slug":"home-automation"},{"id":20,"name":"image-editing","display_name":"Image editing","slug":"image-editing"},{"id":28,"name":"iot","display_name":"IoT","slug":"iot"},{"id":13,"name":"local-llm","display_name":"Local LLM","slug":"local-llm"},{"id":17,"name":"mcp","display_name":"MCP","slug":"mcp"},{"id":47,"name":"monitoring","display_name":"Monitoring","slug":"monitoring"},{"id":2,"name":"nlp","display_name":"NLP","slug":"nlp"},{"id":26,"name":"observability","display_name":"Observability","slug":"observability"},{"id":40,"name":"pentesting","display_name":"Pentesting","slug":"pentesting"},{"id":48,"name":"programming-examples","display_name":"Programming examples","slug":"programming-examples"},{"id":42,"name":"proxy","display_name":"Proxy","slug":"proxy"},{"id":14,"name":"rag","display_name":"RAG","slug":"rag"},{"id":56,"name":"resume-building","display_name":"Resume building","slug":"resume-building"},{"id":33,"name":"robotics","display_name":"Robotics","slug":"robotics"},{"id":30,"name":"search","display_name":"Search","slug":"search"},{"id":43,"name":"self-hosted","display_name":"Self-hosted","slug":"self-hosted"},{"id":50,"name":"static-analysis","display_name":"Static analysis","slug":"static-analysis"},{"id":18,"name":"synthetic-data","display_name":"Synthetic data","slug":"synthetic-data"},{"id":19,"name":"text-to-speech","display_name":"Text to speech","slug":"text-to-speech"},{"id":53,"name":"ui-components","display_name":"UI components","slug":"ui-components"},{"id":15,"name":"vector-database","display_name":"Vector database","slug":"vector-database"},{"id":21,"name":"video-editing","display_name":"Video editing","slug":"video-editing"},{"id":25,"name":"web-scraping","display_name":"Web scraping","slug":"web-scraping"},{"id":55,"name":"webassembly","display_name":"WebAssembly","slug":"webassembly"},{"id":23,"name":"workflow-automation","display_name":"Workflow automation","slug":"workflow-automation"}]" returns me the "expected json"