Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1 KB

README.md

File metadata and controls

40 lines (33 loc) · 1 KB

nuber

Inspired by epy, nuber is an Epub terminal reader with inline images written with Rust and Python using Überzug.

title

Features

  • Display images in terminal.
  • Movement with vim keys hjkl.
  • Table of content navigation with t.
  • Dynamic window resize.
  • Rememebers last position per book.

Installation

Requirements: maturin, pip

$ git clone https://github.com/mtshrmn/nuber.git --recursive && cd nuber
$ cd rust-html2text && git apply ../html2text.patch && cd ..
$ maturin build --release
$ pip install .

Usage

$ nuber --help
Usage: nuber [OPTIONS] BOOK

Options:
  --help  Show this message and exit.

Contribute

Requirements: maturin, poetry

$ git clone https://github.com/mtshrmn/nuber.git --recursive && cd nuber
$ cd rust-html2text && git apply ../html2text.patch && cd ..
$ poetry install && poetry shell
$ maturin develop && exit
$ poetry run nuber