Upload library homepage
[org-kindle.git] / README.org
blobfe607c053a0eb952377902e909904a057882b599
1 * What it is?
3 Connect Emacs Org Mode with Kindle reader with transfering ebooks and more.
5 #+ATTR_ORG: :width 600
6 #+ATTR_LATEX: :width 6.0in
7 #+ATTR_HTML: :width 600px
8 [[file:org-kindle.png]]
10 * Motivation
12 Because I store ebooks in Org Wiki style database. All ebooks are organized (use
13 =org-attach=) with links in Org-mode files under some kind of knowledge category
14 structure directories. So I need to send an ebook to external device with one
15 keybinding or one command instead of manually copy with complex path (=org-attach=
16 use some kind of prefix for storing directory).
18 * External Dependencies
20 This packages use a command =ebook-convert= which comes from [[https://calibre-ebook.com/][Calibre]]. So if you
21 want to use auto convert functionality, you need to install it manuall.
23 * Features
25 - auto send the file under org-mode ~file://~ link to your external devices like
26   Kindle, NOOK etc with corresponding formats.
27   - auto convert to corresponding formats if necessary. Like send =.epub= to
28     Kindle by auto converting to =.mobi= or =.azw3= formats depending on your option
29     ~org-send-ebook-kindle-default-format~.
31 * Todos
33 - [ ] One command =org-kindle-sync-notes= to sync Kindle's notes with Org Mode notes file.
35 * Notices
37 In theatrically, this package should work for non-kindle ereaders too. User can
38 set device path in variables. But becaused not tested, so I can't guarantee that
39 package will work correctly. But PR welcome to improve it. I appreciate it.