blob: eb614d7b3d4967e324113a6c1930d5ca45cf76b8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# bk
bk is a WIP terminal Epub reader, written in Rust.
# Features
- Cross platform - Linux, macOS and Windows support
- Single binary, instant startup
- Epub 2/3 support
- Vim bindings
- Incremental search
- Bookmarks
# Install
Install from crates.io:
cargo install bk
or from github:
git clone https://github.com/aeosynth/bk
cargo install --path bk
# Usage
Usage: bk [<path>] [-m] [-t] [-w <width>]
read a book
Options:
-m, --meta print metadata and exit
-t, --toc start with table of contents open
-w, --width characters per line
--help display usage information
Running `bk` without a path will load the most recent Epub.
Type any function key (eg <kbd>F1</kbd>) to see the keybinds.
# Configuration alternatives
- Theming: theme your terminal
- Config file: create an alias with cli options
# TODO
- more configuration
- better html support
- test unicode
- github actions / ci
- css?
- mobi?
# Inspiration
<https://github.com/wustho/epr>
|
