aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 134308c0e6ce6f5403e70206c6375ea31a09b8d1 (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
# 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
- Incremental search
- Vim bindings

# Usage

Install from crates.io:

    cargo install bk

or from github:

    git clone https://github.com/aeosynth/bk
    cargo install --path bk

then run:

    bk path/to/epub

Type any function key (eg <kbd>F1</kbd>) to see the commands.

Running `bk` without an argument will load the most recent Epub.

# TODO
- configuration
- links
- better unicode support
- better html rendering
- mobi?
- images?
- css?
- gui?

# Inspiration
<https://github.com/wustho/epr>