diff --git a/README.md b/README.md index 87e12b0..f203b5a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ DjVuMaker Plugin for Calibre This plugin adds DJVU output conversion for Postscript documents (*.pdf, .ps). Files can be converted through a GUI menu and optionally as FileType hook for automatically converting imports of all Postscript documents. -[Screenshot of GUI Menu & Job log] +![GUI menu](/screenshot_menu.png?raw=true) +![Job log](/screenshot_job.png?raw=true) DjVU files are best for rendering large image-based documents (100+ pg. black-and-white-scaned archive-books) on markup-ebook readers with sub-300MiB memory and sub-2GiB storage capacities. The community-made Kindle readers kindlepdfviewer & koreader support DjVu files and can deliver noticable speed increase over PDF originals of such documents. @@ -11,36 +12,31 @@ Some massive 1000+ page books can only be read unsplit on these devices in DjVu PDF is still better for vector/markup based "ebooks" so this plugin will not try to convert documents it detects having less than 1 raster image per page. -Under the Hood ---- -There are a few implementations of DjVU tools in the wild, but the fastest and most robust free one is the DjVuLibre suite and its Ghostscript plugin "GsDjvu". -GsDjvu was witlessly licensed by AT&T with a "free" but GPL-incompatible license which makes pre-compiled packages impossible to publically distribute. -Therefore both packages must be built by the user in a complicated procedure, which the plugin tries to facilitate when installed into Calibre. - Installation --- -* Right click the preferences button in calibre, select get new plugins, scroll down the list and choose the DjVuMaker plugin to install -[screenshot] -* Or, download the zip and install it from the shell -```bash -wget github.com/kfix/calibre_plugin_djvumaker/master/zipfile -calibre-customize -b master.zip -``` -* Or++, clone this repo and install from source -```bash -git clone github.com/kfix/calibre-plugin-djvumaker +1. Right click the preferences button in calibre, select get new plugins, scroll down the list and choose the DjVuMaker plugin to install + * Or, download the zip and install it from the shell +```wget https://github.com/kfix/calibre_plugin_djvumaker/archive/master.zip + +calibre-customize -b master.zip``` + * Or++, clone this repo and install from source +```git clone github.com/kfix/calibre-plugin-djvumaker + cd calibre-plugin-djvumaker -./__init__.py -``` - -* [Required] Build the conversion programs -```calibre-debug -R djvumaker install_deps``` -**Only works on OSX for now** -* [Optional] run a test conversion out-of-GUI against the included PDF. Press CTRL-C to exit. +./__init__.py``` +2. [Required] Build the conversion programs (**fixme: works only on OSX**) +```calibre-debug -R djvumaker install_deps``` +3. [Optional] run a test conversion out-of-GUI against the included PDF. ```calibre-debug -R djvumaker test.pdf``` +4. (Re)start Calibre and start converting your PDF books! + +Under the Hood +--- +There are a few implementations of DjVU tools in the wild, but the fastest and most robust free one is the DjVuLibre suite and its Ghostscript plugin "GsDjvu". +GsDjvu was witlessly licensed by AT&T with a "free" but GPL-incompatible license which makes pre-compiled packages impossible to publically distribute. +Therefore both packages must be built by the user in a complicated procedure, which the plugin tries to facilitate when installed into Calibre. -* (Re)start Calibre and start converting your PDF books! Q: Why not write a "standard" Conversion Plugin for DjVU? --- diff --git a/screenshot_job.png b/screenshot_job.png new file mode 100644 index 0000000..45b13e8 Binary files /dev/null and b/screenshot_job.png differ diff --git a/screenshot_menu.png b/screenshot_menu.png new file mode 100644 index 0000000..2eb2f1b Binary files /dev/null and b/screenshot_menu.png differ