https://github.com/thesage21/bookread
Espeak Manager for reading plaintext books[MERGED with reimagined-chainsaw project]
https://github.com/thesage21/bookread
Last synced: about 1 month ago
JSON representation
Espeak Manager for reading plaintext books[MERGED with reimagined-chainsaw project]
- Host: GitHub
- URL: https://github.com/thesage21/bookread
- Owner: theSage21
- License: mit
- Created: 2016-03-27T16:22:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-17T08:38:13.000Z (about 9 years ago)
- Last Synced: 2025-01-28T21:29:56.180Z (3 months ago)
- Language: Python
- Homepage: https://github.com/theSage21/reimagined-chainsaw
- Size: 4.88 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BookRead
*Notice* This has been merged with [reimagined-chainsaw](https://github.com/theSage21/reimagined-chainsaw)
Espeak Manager for reading plaintext books
USAGE
-----
`bkrd [TextFileName] [start_at_line]`
Control
-------
While the book is being read you can use the following keys to
control the reader.
|Key |Description
--------------|-------------
|**space bar**|to toggle pause and play. Current sentence will be completed before pause or play.
|p | print the text of the sentence currently being spoken
|s | sentence number so that you can see how much is done.
|r | remember this position and start from this the next time this book is read. If a position is specified, that will be used as a start point instead.
|q | quit
INFO
----
While reading some things are printed on screen. They are in the
following format:
`[LINE_NO] [%DONE] [TRUNCATED_LINE_TEXT]`
Example
-------
`bkrd myfile.txt` reads the text in myfile.txt
`bkrd myfile.txt 10` reads the text in myfile.txt starting at line 10
`bkrd --help` displays this help and exits
Files Generated
---------------
BKRD generates one file in your home folder called `.bkrd`
This is the file used to keep track of last read positions
in the books you have read.
For example in my laptop, it is the file `/home/arjoonn/.bkrd`