Skip to content

Commit

Permalink
fix zip path and add screenshots in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kfix committed Jul 23, 2014
1 parent ef983bb commit 0487a82
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 25 deletions.
46 changes: 21 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,40 @@ 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.
Some massive 1000+ page books can only be read unsplit on these devices in DjVu format.

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?
---
Expand Down
Binary file added screenshot_job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0487a82

Please sign in to comment.