diff options
author | Ciro Mattia Gonano <ciromattia@gmail.com> | 2012-11-30 14:30:07 +0100 |
---|---|---|
committer | Ciro Mattia Gonano <ciromattia@gmail.com> | 2012-11-30 14:30:07 +0100 |
commit | 8865bb44b8fa47d727ec2547569cc80eadc299dc (patch) | |
tree | c58e6e0f11d39c44d9bbc0808df63816b246bf61 /README.md | |
parent | Add scripts and update readme (diff) | |
download | kcc-8865bb44b8fa47d727ec2547569cc80eadc299dc.tar.gz kcc-8865bb44b8fa47d727ec2547569cc80eadc299dc.tar.bz2 kcc-8865bb44b8fa47d727ec2547569cc80eadc299dc.zip |
Update readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/README.md b/README.md index adc28f5..13cfe3e 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,47 @@ -KindleComicConverter -============= +# KindleComicConverter -KindleComicConverter is a MacOS X AppleScript droplet to convert image folders to a comic-type Mobipocket ebook to take advantage of the new Panel View mode on Amazon's Kindle. +`KindleComicConverter` is a MacOS X AppleScript droplet to convert image folders to a comic-type Mobipocket ebook to take advantage of the new Panel View mode on Amazon's Kindle. -REQUIREMENTS -------------- - - kindlegen in /usr/local/bin/ - - [http://www.rarlab.com/download.htm](unrar) and [http://developer.berlios.de/project/showfiles.php?group_id=5373&release_id=18844](rarfile.py) for calibre2ebook.py automatic CBR extracting +## REQUIREMENTS + - `kindlegen` in /usr/local/bin/ + - [unrar](http://www.rarlab.com/download.htm) and [rarfile.py](http://developer.berlios.de/project/showfiles.php?group_id=5373&release_id=18844) for `calibre2ebook.py` automatic CBR extracting -USAGE -------------- -Drop a folder over the droplet, after a while you'll get a comic-type .mobi to sideload on your kindle. -The script takes care of calling comic2ebook.py, kindlegen and kindlestrip.py. -For the standalone comic2ebook.py script, please refer to CLI help. +## USAGE +Drop a folder over the droplet, after a while you'll get a comic-type .mobi to sideload on your Kindle. +The script takes care of calling `comic2ebook.py`, `kindlegen` and `kindlestrip.py`. -WARNING: at the moment the script does not perform image manipulation. Image optimization and resizing (HD Kindles want 758x1024, non-HD ones 600x800) is up to you. +For the standalone `comic2ebook.py` script: + python comic2ebook.py <directory> <title> -CREDITS -------------- -This script exists as a cross-platform alternative to KindleComicParser by Dc5e -(published in [http://www.mobileread.com/forums/showthread.php?t=192783](http://www.mobileread.com/forums/showthread.php?t=192783)) +**WARNING:** at the moment the script does not perform image manipulation. Image optimization and resizing (HD Kindles want 758x1024, non-HD ones 600x800) is up to you. -This droplet relies and includes KindleStrip (C) by Paul Durrant and released in public domain -([http://www.mobileread.com/forums/showthread.php?t=96903](http://www.mobileread.com/forums/showthread.php?t=96903)) -The icon for the droplet is by Nikolay Verin ([http://ncrow.deviantart.com/](http://ncrow.deviantart.com/)) and released under CC Attribution-NonCommercial-ShareAlike 3.0 Unported License +## CREDITS +This script exists as a cross-platform alternative to `KindleComicParser` by **Dc5e** +(published in [this mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=192783)) -Also, you need to have kindlegen v2.7 (with KF8 support) which is downloadable from Amazon website -and installed in /usr/local/bin/ +This droplet relies on and includes `KindleStrip` (C) by **Paul Durrant** and released in public domain +([mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=96903)) +The icon for the droplet is by **Nikolay Verin** ([http://ncrow.deviantart.com/](http://ncrow.deviantart.com/)) and released under [CC Attribution-NonCommercial-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-nc-sa/3.0/) License -CHANGELOG -------------- +Also, you need to have `kindlegen` v2.7 (with KF8 support) which is downloadable from Amazon website +and installed in `/usr/local/bin/` + + +## CHANGELOG - 1.00 - Initial version - 1.10 - Added support for CBZ/CBR files in comic2ebook.py -TODO -------------- +### TODO - add transparent support for CBZ/CBR archives - bundle a script to manipulate images (to get rid of Mangle/E-nki/whatsoever) -TODO for calibre2ebook.py -------------- +#### calibre2ebook.py - Add gracefully exit for CBR if no rarfile.py and no unrar executable are found - - Improve error reporting \ No newline at end of file + - Improve error reporting + +## COPYRIGHT + +Copyright (c) 2012 Ciro Mattia Gonano. See LICENSE.txt for further details. \ No newline at end of file |