Skip to content

Commit 9dab92f

Browse files
committed
Edit meta.
1 parent 5d0a1e1 commit 9dab92f

File tree

2 files changed

+43
-31
lines changed

2 files changed

+43
-31
lines changed

README.md

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -96,47 +96,59 @@ Key Binding:
9696

9797
## Known Issues
9898

99-
- Search function can't find occurences that span across multiple lines
99+
1. Search function can't find occurences that span across multiple lines
100100

101-
Only capable of finding pattern that span inside a single line, not sentence.
102-
So works more effectively for finding word or letter rather than long phrase or sentence.
101+
Only capable of finding pattern that span inside a single line, not sentence.
102+
So works more effectively for finding word or letter rather than long phrase or sentence.
103103

104-
As workarounds, You can increase text area width to increase its reach or dump
104+
As workarounds, You can increase text area width to increase its reach or dump
105105
the content of epub using `-d` option, which will dump each paragraph into a single line separated by empty line (or lines depending on the epub), to be later piped into `grep`, `rg` etc. Pretty useful to find book quotes.
106106

107-
Example:
107+
Example:
108108

109-
```shell
110-
# to get 1 paragraph before and after a paragraph containing "Overdue"
111-
$ epr -d the_girl_next_door.epub | grep Overdue -C 2
112-
```
109+
```shell
110+
# to get 1 paragraph before and after a paragraph containing "Overdue"
111+
$ epr -d the_girl_next_door.epub | grep Overdue -C 2
112+
```
113113

114-
- <sup>Superscript</sup> and <sub>subscript</sub> displayed as `^{Superscript}` and `_{subscript}`.
114+
2. <sup>Superscript</sup> and <sub>subscript</sub> displayed as `^{Superscript}` and `_{subscript}`.
115115

116-
- "-" chapters in TOC
116+
3. Some TOC issues:
117117

118-
This happens because not every chapter file (inside some epubs) is given navigation points.
119-
Some epubs even won't let you navigate between chapter, thus you'll find all chapters named as
120-
"-" using `epr` for these kind of epubs.
118+
- "-" chapters in TOC
121119

122-
- Skipped chapters in TOC
120+
This happens because not every chapter file (inside some epubs) is given navigation points.
121+
Some epubs even won't let you navigate between chapter, thus you'll find all chapters named as
122+
"-" using `epr` for these kind of epubs.
123123

124-
Example:
124+
- Skipped chapters in TOC
125125

126-
```
127-
Table of Contents
128-
-----------------
126+
Example:
129127

130-
1. Title Page
131-
2. Chapter I
132-
3. Chapter V
133-
```
128+
```
129+
Table of Contents
130+
-----------------
134131
135-
This happens because Chapter II to Chapter IV is probably in the same file with Chapter I,
136-
but in different sections, e. g. `ch000.html#section1` and `ch000.html#section2.`
132+
1. Title Page
133+
2. Chapter I
134+
3. Chapter V
135+
```
137136
138-
But don't worry, you should not miss any part to read. This just won't let you navigate
139-
to some points using TOC.
137+
This happens because Chapter II to Chapter IV is probably in the same file with Chapter I,
138+
but in different sections, e. g. `ch000.html#section1` and `ch000.html#section2.`
139+
140+
But don't worry, you should not miss any part to read. This just won't let you navigate
141+
to some points using TOC.
142+
143+
If you feel bothered by these 2 TOC issues, checkout branch `commontoc` or install via:
144+
145+
```shell
146+
$ pip install git+https://github.com/wustho/epr.git@commontoc
147+
```
148+
149+
which will give you TOC behavior like in many common readers.
150+
151+
NOTE: I'm not merging `commontoc` to `master` since `master` already does most of its job efficiently and (supposedly, I'm not doing any test) faster. It just navigates between files inside epub rather than pre-defined sections like `commontoc` does.
140152

141153
## Inspirations
142154

setup.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import sys
22
from setuptools import setup
3-
from epr import __version__
3+
from epr import __version__, __author__, __url__, __license__
44

55
setup(
66
name = "epr",
77
version = __version__,
88
description = "Terminal/CLI Epub Reader",
9-
url = "https://github.com/wustho/epr",
10-
author = "Benawi Adha",
11-
license = "MIT",
9+
url = __url__,
10+
author = __author__,
11+
license = __license__,
1212
keywords = ["EPUB", "EPUB3", "CLI", "Terminal", "Reader"],
1313
install_requires = ["windows-curses"] if sys.platform == "win32" else [],
1414
python_requires = "~=3.7",

0 commit comments

Comments
 (0)