Add initial README - bookdarts - Extract KOReader generated highlights and publish them in a variety of formats↵ DIR Log DIR Files DIR Refs DIR README --- DIR commit 1b987e344010770c9528df7a20a895ad1a905c34 DIR parent 029678758bcbb1bf08a05f1a062c2ee4216ce7e7 HTML Author: Scarlett McAllister <no+reply@roygbyte.com> Date: Wed, 18 Oct 2023 23:19:31 -0300 Add initial README Diffstat: A README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+), 0 deletions(-) --- DIR diff --git a/README b/README @@ -0,0 +1,19 @@ +# Bookdarts + +Bookdarts is a command line program that converts KOReader generated highlights into a GPH menu and associated text files. + +# Instructions +## Generate the highlights file on your KOReader + +## Copy the highlights file from your device +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. + +## Optional: Clean up the book titles +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`. + +Run `title-exporter.sh` first, passing your highlights file as the sole argument. + +``` bash +./title-exporter.sh highlights-from-device.json +``` +