README - bookdarts - Extract KOReader generated highlights and publish them in a variety of formats↵
DIR Log
DIR Files
DIR Refs
DIR README
---
README (945B)
---
1 # Bookdarts
2
3 Bookdarts is a command line program that converts KOReader generated highlights into a GPH menu and associated text files.
4
5 # Instructions
6 ## Generate the highlights file on your KOReader
7
8 ## Copy the highlights file from your device
9 The highlights file is typically stored on the e-reader's storage at `.adds/koreader/clipboard`. You can use the included `export-from-device.sh` script to automatically copy the highlights file to `bookdart's` directory. However, you will need to make sure the mount point for the device is correct.
10
11 ## Optional: Clean up the book titles
12 A little bit of manual intervention is necessary if you want your book titles to be consistently formatted. Two scripts are included to help clean up the book titles: `title-exporter.sh` and `title-replacer.sh`.
13
14 Run `title-exporter.sh` first, passing your highlights file as the sole argument.
15
16 ``` bash
17 ./title-exporter.sh highlights-from-device.json
18 ```
19