manga-tui

(β˜… 920)

Terminal-based manga reader and downloader with image rendering support

  • .dockerignore
  • .gitignore
  • .rusty-hook.toml
  • bacon.toml
  • Cargo.lock
  • Cargo.toml
  • CONTRIBUTING.md
  • Dockerfile
  • flake.lock
  • flake.nix
  • LICENSE
  • Makefile.toml
  • README.md
  • rust-toolchain.toml
  • rustfmt.toml

# Installation Guide

1. Get the code
git clone https://github.com/josueBarretogit/manga-tui

Downloads the entire project code from GitHub to your computer.

cd manga-tui

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
  • Rust (rustup) Rust is required to use cargo.
sudo apt install libdbus-1-dev pkg-config

Installs directly from the APT package repository (Debian/Ubuntu-based).

cargo install manga-tui --locked

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t manga-tui .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 manga-tui

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install manga-tui --locked

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation