diff options
| author | James Campos <james.r.campos@gmail.com> | 2020-06-14 12:26:40 -0700 |
|---|---|---|
| committer | James Campos <james.r.campos@gmail.com> | 2020-06-14 12:26:40 -0700 |
| commit | cd826f78e107d30d38925f5614d7f90fd30b287e (patch) | |
| tree | 5907e8a0e321be7733d7a8ed9b05eae9272331f4 /README.md | |
| parent | 1b8a8b27f7e79d68583e8eef5d15c33f7dd9a955 (diff) | |
| download | bk-cd826f78e107d30d38925f5614d7f90fd30b287e.tar.gz | |
readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 6 insertions, 11 deletions
@@ -9,8 +9,7 @@ bk is a WIP terminal Epub reader, written in Rust. - Incremental search - Bookmarks -# Usage - +# Install Install from crates.io: cargo install bk @@ -20,23 +19,19 @@ or from github: git clone https://github.com/aeosynth/bk cargo install --path bk -then run: - - bk [flags] [path] +# Usage + bk [<path>] [-w <width>] Running `bk` without a path will load the most recent Epub. -The `-w` flag sets the line width. - -Type any function key (eg <kbd>F1</kbd>) to see the commands. +Type any function key (eg <kbd>F1</kbd>) to see the keybinds. # TODO -- configuration +- more configuration - better html support - better unicode support -- mobi? - css? -- gui? +- mobi? # Inspiration <https://github.com/wustho/epr> |