README added.

This commit is contained in:
Martin Brodbeck 2021-01-29 14:52:35 +01:00
parent d850e0f14e
commit 6c136200ce

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# PbDbFixer
## Motivation
Since Pocketbook has some problems with extracting metadata correctly from
EPUB files, this program tries fix these issues. It tries to identify
wrong database entries and fix it by reading the corresponding epub
metadata.
## Compatibility
This program is tested only on a PocketBook Touch HD 3 device (software
version 6.1.900). It might work with other PocketBook devices/software
versions. Please tell me, if it works for you (do make a backup of these
explorer-3.db before trying!).
## Installation and Usage
Just copy the executable file into the PocketBook's application directory.
If you encounter duplicate authors in the PocketBook's library, open the
applications screen and tap on the PbDbFixer icon.
## Build
To be able to build PbDbFixer, you have to have the cross compiler for
ARM CPUs installed. On Arch Linux, the AUR package `arm-linux-gnueabi-gcc75-linaro-bin`
does the job. Don't forget tell `cargo` which compiler/linker it has to
invoke. In my case, I hat to edit `~/.cargo/config`:
```
[target.arm-unknown-linux-gnueabi]
linker = "arm-linux-gnueabi-gcc"
```
Now you can easily compile the stuff by invoking
```
cargo build --release --target=arm-unknown-linux-gnueabi
```