Comicviewer/README.md

51 lines
1.5 KiB
Markdown

# Comicviewer
Comicviewer is a GTK4 desktop application for browsing and reading comic image
archives stored locally or on SMB, FTP, and SFTP servers.
한국어 문서:
- [설치 및 실행 안내](docs/INSTALL.ko.md)
- [AppImage Release 배포 안내](docs/RELEASING.ko.md)
The project is currently in early development. It supports saved local, SMB,
FTP, and SFTP locations, complete remote ZIP downloads with an LRU cache,
natural sorting, safe on-demand image decoding and prefetching, single-page and
two-page viewing, continuous vertical scrolling, reading progress, and
XDG-compliant configuration.
## Development dependencies
On CachyOS or Arch Linux:
```sh
sudo pacman -S rust gtk4 dav1d sqlite gvfs gvfs-smb
```
Run the application with:
```sh
cargo run
```
The AppImage uses the host's GTK4 and dav1d libraries. GVfs provides the FTP
and SFTP backends, while `gvfs-smb` adds SMB support. These packages must be
installed on the host.
Application files are stored below the standard XDG configuration, data, and
cache directories. No runtime state is written into the source tree.
## AppImage
The AppImage build uses `appimagetool`. The script can extract appimagetool
from a linuxdeploy AppImage when it is not provided directly:
```sh
PATH="/path/to/appimage-tools:$PATH" \
LINUXDEPLOY="/path/to/linuxdeploy-x86_64.AppImage" \
./packaging/build-appimage.sh
```
The resulting file is written to `dist/`. Remote locations still require the
host system's GVfs services and protocol backends, including `gvfs-smb` for
SMB.