Merge remote-tracking branch 'johnfactotum/gtk4' into gtk4

.github/workflows/deb.yml

@@ -0,0 +1,36 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build Debian Package
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ gtk4 ]
+  pull_request:
+    branches: [ gtk4 ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-24.04
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+        with:
+          submodules: 'true'
+
+      - run: sudo apt install build-essential debhelper meson gettext pkg-config libglib2.0-dev gjs appstream libgjs-dev libgtk-4-dev libadwaita-1-dev libwebkitgtk-6.0-dev desktop-file-utils
+      - run: dpkg-buildpackage -us -uc -nc
+      - run: mv ../*.deb .
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Debian Package
+          path: "*.deb"

README.md

@@ -25,7 +25,13 @@ If installed, `tracker` (>= 3; `gir1.2-tracker-3.0` in Debian-based distros) and
 
 ### Obtaining the Source
 
-The repo uses git submodules. Before running or installing, make sure you clone the whole thing with `--recurse-submodules`.
+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
 

debian/control

@@ -2,7 +2,7 @@ Source: foliate
 Section: gnome
 Priority: optional
 Maintainer: John Factotum <[email protected]>
-Build-Depends: debhelper-compat(=10),
+Build-Depends: debhelper-compat(=13),
 	gettext,
 	meson (>= 0.59),
 	pkg-config,

docs/faq.md

@@ -28,6 +28,8 @@ To use it, click on the <i>Narration</i> button (the one with a headphones icon)
 
 Alternatively you can select some text and choose <i>Speak from Here</i> from the selection menu. Though you still need to use the <i>Narration</i> button if you want to stop the speech output.
 
+The default voice may sound somewhat robotic. You can use [Pied](https://pied.mikeasoft.com/) (a frontend for configuring [Piper](https://github.com/rhasspy/piper)) to change that to a more natural sounding voice. See [this](https://askubuntu.com/a/1526192/124466) for more details.
+
 ### How to use custom themes?
 
 Themes are defined as JSON files. Here is an example theme:
@@ -48,7 +50,11 @@ Themes are defined as JSON files. Here is an example theme:
 }
 ```
 
-To install themes, you need to put them in `/home/user/.config/com.github.johnfactotum.Foliate/themes/`. If you're using Flatpak, the files should be placed in `~/.var/app/com.github.johnfactotum.Foliate/config/com.github.johnfactotum.Foliate/themes/`.
+To install themes, you need to put them in `/home/user/.config/com.github.johnfactotum.Foliate/themes/`.
+
+When using Flatpak, the files should be placed in `~/.var/app/com.github.johnfactotum.Foliate/config/com.github.johnfactotum.Foliate/themes/`.
+
+When using Snap, the files should be placed in `~/snap/foliate/current/.config/com.github.johnfactotum.Foliate/themes/`.
 
 ### Can I set my own custom CSS styles?
 
@@ -62,7 +68,9 @@ Tip: you can use the [`:lang()`](https://developer.mozilla.org/en-US/docs/Web/CS
 
 Your reading progress, bookmarks, and annotations are saved in `~/.local/share/com.github.johnfactotum.Foliate`.
 
-If you're using the Flatpak version, they should be in `~/.var/app/com.github.johnfactotum.Foliate/data/com.github.johnfactotum.Foliate`.
+When using Flatpak, they are placed in `~/.var/app/com.github.johnfactotum.Foliate/data/com.github.johnfactotum.Foliate`.
+
+When using Snap, they are placed in `~/snap/foliate/current/.local/share/com.github.johnfactotum.Foliate`.
 
 The data for each book is stored in a JSON file named after the book's identifier. If you'd like to sync or backup your progress and notes, simply copy these files and everything should just work™.