Add AppImage installation and release guides

This commit is contained in:
burnintuna 2026-07-21 02:36:37 +09:00
parent 8d973f77dd
commit a1b941e8f5
4 changed files with 181 additions and 0 deletions

87
docs/INSTALL.ko.md Normal file
View file

@ -0,0 +1,87 @@
# Comicviewer 설치 및 실행 안내
Comicviewer는 CachyOS와 Arch Linux에서 사용할 수 있는 만화 ZIP 뷰어입니다.
로컬 파일뿐 아니라 SMB, FTP, SFTP 서버의 폴더와 ZIP 파일도 열 수 있습니다.
## 1. 필수 패키지 설치
AppImage 실행과 원격 파일 접근에 필요한 패키지를 설치합니다.
```sh
sudo pacman -S fuse2 gvfs gvfs-smb
```
- `fuse2`: AppImage 마운트 및 실행
- `gvfs`: FTP와 SFTP 접근
- `gvfs-smb`: SMB 공유 접근
## 2. 다운로드 검증
Release 페이지에서 다음 두 파일을 같은 폴더에 다운로드합니다.
- `Comicviewer-0.1.0-x86_64.AppImage`
- `Comicviewer-0.1.0-x86_64.AppImage.sha256`
다운로드한 폴더에서 체크섬을 검증합니다.
```sh
sha256sum -c Comicviewer-0.1.0-x86_64.AppImage.sha256
```
`성공` 또는 `OK`가 표시되어야 합니다. 검증에 실패하면 파일을 실행하지 말고
다시 다운로드합니다.
## 3. 실행
AppImage에 실행 권한을 부여한 뒤 실행합니다.
```sh
chmod +x Comicviewer-0.1.0-x86_64.AppImage
./Comicviewer-0.1.0-x86_64.AppImage
```
FUSE를 사용할 수 없는 환경에서는 다음과 같이 임시 추출 방식으로 실행할 수
있습니다.
```sh
./Comicviewer-0.1.0-x86_64.AppImage --appimage-extract-and-run
```
## 4. 선택 사항: 사용자 계정에 설치
AppImage를 사용자 전용 프로그램 폴더에 설치하고 명령어로 실행하려면 다음을
사용합니다.
```sh
mkdir -p ~/.local/opt/comicviewer ~/.local/bin
install -m 755 Comicviewer-0.1.0-x86_64.AppImage \
~/.local/opt/comicviewer/Comicviewer.AppImage
ln -sfn ~/.local/opt/comicviewer/Comicviewer.AppImage ~/.local/bin/comicviewer
```
이후 새 터미널에서 다음 명령으로 실행할 수 있습니다.
```sh
comicviewer
```
`~/.local/bin`이 `PATH`에 없으면 AppImage의 전체 경로로 실행합니다.
## 데이터 저장 위치
Comicviewer는 XDG 표준 경로를 사용합니다.
- 설정: `${XDG_CONFIG_HOME:-~/.config}/comicviewer/`
- 읽기 기록과 데이터: `${XDG_DATA_HOME:-~/.local/share}/comicviewer/`
- 원격 ZIP 캐시: `${XDG_CACHE_HOME:-~/.cache}/comicviewer/`
저장한 원격 위치의 사용자명과 비밀번호는 설정 파일에 평문으로 기록됩니다.
설정 파일 권한은 `0600`으로 제한되지만, 설정 파일을 다른 사람에게 전달하거나
공유하지 않아야 합니다.
## 원격 파일 이용 참고 사항
- SMB 접속에는 호스트 시스템의 `gvfs-smb`가 필요합니다.
- FTP와 SFTP 접속에는 호스트 시스템의 GVfs 서비스가 필요합니다.
- 원격 ZIP은 열기 전에 로컬 캐시로 완전히 다운로드됩니다.
- 기본 영구 ZIP 캐시 한도는 10GB이며 설정에서 변경할 수 있습니다.