106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
<p align="center"><img src="lector/resources/raw/logo/logotype_horizontal.png" alt="Lector" height="90px"></p>
|
|
|
|
Qt based ebook reader
|
|
|
|
Currently supports:
|
|
* pdf
|
|
* epub
|
|
* fb2
|
|
* mobi
|
|
* azw / azw3 / azw4
|
|
* cbr / cbz
|
|
|
|
## Contribute
|
|
[Paypal](https://www.paypal.me/supportlector)
|
|
|
|
Bitcoin: 17jaxj26vFJNqQ2hEVerbBV5fpTusfqFro
|
|
|
|
## Requirements
|
|
### Needed
|
|
| Package | Version tested |
|
|
| --- | --- |
|
|
| Python | 3.6 |
|
|
| PyQt5 | 5.10.1 |
|
|
| python-lxml | 4.3.0 |
|
|
| python-beautifulsoup4 | 4.6.0 |
|
|
| python-xmltodict | 0.11.0 |
|
|
|
|
### Optional
|
|
| Package | Version tested |
|
|
| --- | --- |
|
|
| python-pymupdf | 1.14.5 |
|
|
|
|
## Support
|
|
When reporting issues:
|
|
* Make sure you're at the latest commit.
|
|
* Run with `$EXECUTABLEPATH debug`.
|
|
* Include the log `~/.local/share/Lector/Lector.log` AND terminal output.
|
|
* If you're having trouble with a book while the rest of the application / other books work, please link to a copy of the book itself.
|
|
* If nothing is working, please make sure the requirements mentioned above are all installed, and are at least at the version mentioned.
|
|
|
|
## Installation
|
|
### Manual
|
|
0. Install dependencies - I recommend using your package manager for this.
|
|
1. Clone repository
|
|
2. Type the following in the root directory:
|
|
|
|
$ python setup.py build
|
|
# python setup.py install
|
|
3. OR launch with `lector/__main__.py`
|
|
|
|
### Available packages
|
|
* [AUR - Releases](https://aur.archlinux.org/packages/lector/)
|
|
* [AUR - Git](https://aur.archlinux.org/packages/lector-git/)
|
|
* [Gentoo (unofficial)](https://bitbucket.org/szymonsz/gen2-overlay/src/master/app-text/lector/)
|
|
* [Fedora (unofficial)](https://copr.fedorainfracloud.org/coprs/bugzy/lector/)
|
|
* [openSUSE](https://software.opensuse.org/package/lector)
|
|
|
|
## Translations
|
|
1. There is a `SAMPLE.ts` file [here](https://github.com/BasioMeusPuga/Lector/tree/master/lector/resources/translations). Open it in `Qt Linguist`.
|
|
2. Pick the language you wish to translate to.
|
|
3. Translate relevant strings.
|
|
4. Try to resist the urge to include profanity.
|
|
5. Save the file as `Lector_<language>` and send it to me, preferably as a pull request.
|
|
|
|
Please keep the translations short. There's only so much space for UI elements.
|
|
|
|
## Screenshots
|
|
|
|
### Main window
|
|
|
|
|
|
### Table view
|
|
|
|
|
|
### Book reading view
|
|
|
|
|
|
### Distraction free view
|
|
|
|
|
|
### Annotation support
|
|
|
|
|
|
### Comic reading view
|
|
|
|
|
|
### Bookmark support
|
|
|
|
|
|
### View profiles
|
|
|
|
|
|
### Metadata editor
|
|
|
|
|
|
### In program dictionary
|
|
|
|
|
|
### Settings window
|
|
|
|
|
|
## Attributions
|
|
* [KindleUnpack](https://github.com/kevinhendricks/KindleUnpack)
|
|
* [rarfile](https://github.com/markokr/rarfile)
|
|
* [Papirus icon theme](https://github.com/PapirusDevelopmentTeam/papirus-icon-theme)
|