https://github.com/andrewmaksimchuk/readbook
CLI application for read only one book automatically
https://github.com/andrewmaksimchuk/readbook
bash book linux pdf terminal
Last synced: about 1 month ago
JSON representation
CLI application for read only one book automatically
- Host: GitHub
- URL: https://github.com/andrewmaksimchuk/readbook
- Owner: AndrewMaksimchuk
- Created: 2023-07-11T17:45:36.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-16T15:21:18.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T11:53:53.536Z (3 months ago)
- Topics: bash, book, linux, pdf, terminal
- Language: Shell
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: history.bash
Awesome Lists containing this project
README
# readbook
### Description
CLI application for read only one book
automatically
### First start
Run `sudo ./install.bash` from project directory
`sudo` need for add to shell complition directory
This add path to this directory to app entry
point in `PATH` variable to `.bashrc` or `.zshrc`
After that add shell complition(bash and zsh)
and make all `.bash` file to be executable
### Usage
See [usage](usage)
### Config file(config)
Key-value storage
| key | description |
| --- | ----------- |
|`book` | path to book, set by use 'add' command |
|`pages` | total number of pages in book |
|`current_page` | what page read(starts with 1) |
|`output_format` | supported output format (default image)|
|`input_format` | supported book format (default pdf) |