Browse Source

docs+flake: add runtime deps for metadata/covers

- Add poppler_utils and unzip to devShell and runtime PATH wrapper\n- Document dependencies and installation instructions in README
Codex CLI 4 months ago
parent
commit
0b740412d0
2 changed files with 25 additions and 0 deletions
  1. 22 0
      README.md
  2. 3 0
      flake.nix

+ 22 - 0
README.md

@@ -4,3 +4,25 @@ This is a Free Pascal/Lazarus project to keep all your ebooks (and pdfs) organiz
 ![Screenshot](/screenshot/mybookshelf_screenshot2.png?raw=true "GTK Screenshot")
 
 ![Screenshot](/screenshot/mybookshelf_screenshot3.png?raw=true "GTK Screenshot")
+
+## Dependencies
+
+- Poppler utils: provides `pdftoppm` and `pdfinfo` used to extract PDF covers and metadata
+- unzip: used to read EPUB metadata from the OPF file
+
+On Nix, these are included via the flake. Use:
+
+- `nix develop` to enter the dev shell (PATH includes poppler_utils and unzip)
+- `nix run` to run the packaged app (wrapper sets PATH to include these tools)
+
+On Debian/Ubuntu:
+
+- `sudo apt-get install poppler-utils unzip`
+
+On Fedora:
+
+- `sudo dnf install poppler-utils unzip`
+
+On Arch:
+
+- `sudo pacman -S poppler unzip`

+ 3 - 0
flake.nix

@@ -36,6 +36,7 @@
           pkgs.fpc
           lazGtk
           pkgs.poppler_utils
+          pkgs.unzip
           pkgs.openssl
           pkgs.cacert
           pkgs.gdb
@@ -141,6 +142,8 @@
             wrapProgram $out/bin/myBookShelf \
               --set LCLWidgetType gtk2 \
               --set LD_LIBRARY_PATH "${gtkLibPath}:${pkgs.openssl.out}/lib" \
+              --prefix PATH : ${pkgs.poppler_utils}/bin \
+              --prefix PATH : ${pkgs.unzip}/bin \
               --set SSL_CERT_FILE ${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt \
               --set NIX_SSL_CERT_FILE ${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt
             runHook postInstall