fix compilation warnings
[org-kindle.git] / README.org
blob3d24207357660e9ae604c5cacf7abe3082e2ff5c
1 * What it is?
3 #+ATTR_ORG: :width 600
4 #+ATTR_LATEX: :width 6.0in
5 #+ATTR_HTML: :width 600px
6 [[file:org-kindle.png]]
9 * Motivation
11 Because I store ebooks in Org Wiki style database. All ebooks are organized (use
12 =org-attach=) with links in Org-mode files under some kind of knowledge category
13 structure directories. So I need to send an ebook to external device with one
14 keybinding or one command instead of manually copy with complex path (=org-attach=
15 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.
24 * Features
26 - auto send the file under org-mode ~file://~ link to your external devices like
27   Kindle, NOOK etc with corresponding formats.
28   - auto convert to corresponding formats if necessary. Like send =.epub= to
29     Kindle by auto converting to =.mobi= or =.azw3= formats depending on your option
30     ~org-send-ebook-kindle-default-format~.
32 * Todos
34 - [ ] One command =org-kindle-sync-notes= to sync Kindle's notes with Org Mode notes file.
36 * Notices
38 In theatrically, this package should work for non-kindle ereaders too. User can
39 set device path in variables. But becaused not tested, so I can't guarantee that
40 package will work correctly. But PR welcome to improve it. I appreciate it.