about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorCiro Mattia Gonano <ciromattia@gmail.com>2012-11-30 18:08:57 +0100
committerCiro Mattia Gonano <ciromattia@gmail.com>2012-11-30 18:08:57 +0100
commit2b0ca785187dc35902ced57001a46548ca4d9246 (patch)
treebc3cb0878073805cc97ddd7f792d5f7173430149 /README.md
parentUpdate readme (diff)
downloadkcc-2b0ca785187dc35902ced57001a46548ca4d9246.tar.gz
kcc-2b0ca785187dc35902ced57001a46548ca4d9246.tar.bz2
kcc-2b0ca785187dc35902ced57001a46548ca4d9246.zip
Add CBZ/CBR handling to droplet
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 22 insertions, 18 deletions
diff --git a/README.md b/README.md
index bf51211..3577e3f 100644
--- a/README.md
+++ b/README.md
@@ -4,26 +4,26 @@
 
 ## REQUIREMENTS
 - Python (included in MacOS and Linux, follow the [official documentation](http://www.python.org/getit/windows/) to install on Windows)  
-- `kindlegen` in /usr/local/bin/  
+- `kindlegen` in /usr/local/bin/
+
+### for standalone `comic2ebook.py` script:
 - [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.  
-- `comic2ebook.py` can optionally use the [Python Imaging Library](http://www.pythonware.com/products/pil/) to correctly set the image resolution on OPF file, please refer to official documentation for installing into your system.
+
+The app and the standalone `comic2ebook.py` script can optionally use the [Python Imaging Library](http://www.pythonware.com/products/pil/) to correctly set the image resolution on OPF file, please refer to official documentation for installing into your system.
 
 ## 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`.  
+Drop a folder or a CBZ/CBR file 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.
 
-## USAGE (standalone `comic2ebook.py`)
+### standalone `comic2ebook.py` usage:
 1. Prepare image folder resizing the images to 758x1024 for HD or 600x800 for non-HD readers, in .png or .jpg formats
 2. Organize the images into the folders (Use leading 0's to avoid file ordering problems). For example,
 
-	> Legs Weaver/  
-	> Legs Weaver/51/  
-	> Legs Weaver/51/001.png  
-	> Legs Weaver/51/002.png  
-	> Legs Weaver/52/  
-	> Legs Weaver/52/001.png  
-	> Legs Weaver/52/002.png  
+	> Legs Weaver 51/  
+	> Legs Weaver 51/001.png  
+	> Legs Weaver 51/002.png  
 	> etc...
 
 3. Launch
@@ -37,12 +37,16 @@ The script takes care of calling `comic2ebook.py`, `kindlegen` and `kindlestrip.
 
 ## 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))
+(published in [this mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=192783))  
 
-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
+The app relies and includes the following scripts/binaries:
+
+ - the `KindleStrip` script &copy; 2010-2012 by **Paul Durrant** and released in public domain
+([mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=96903))
+ - the `rarfile.py` script &copy; 2005-2011 **Marko Kreen** <markokr@gmail.com>, released with ISC License
+ - the free version `unrar` executable (downloadable from [here](http://www.rarlab.com/rar_add.htm), refer to `LICENSE_unrar.txt` for further details)
+ - the icon 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
 
 Also, you need to have `kindlegen` v2.7 (with KF8 support) which is downloadable from Amazon website
 and installed in `/usr/local/bin/`
@@ -51,9 +55,9 @@ and installed in `/usr/local/bin/`
 ## CHANGELOG
   - 1.00 - Initial version
   - 1.10 - Added support for CBZ/CBR files in comic2ebook.py
+  - 1.11 - Added support for CBZ/CBR files in KindleComicConverter
 
-### TODO
-  - add transparent support for CBZ/CBR archives
+## TODO
   - bundle a script to manipulate images (to get rid of Mangle/E-nki/whatsoever)
 
 #### calibre2ebook.py