about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorCiro Mattia Gonano <ciromattia@gmail.com>2013-01-16 09:53:23 +0100
committerCiro Mattia Gonano <ciromattia@gmail.com>2013-01-16 09:53:23 +0100
commitd823afc3f931b31d963504e5fc3a8eb3a4b2932d (patch)
tree28a0709d835be0934a8a3b42c3dc6def09b4dc5a /README.md
parentAdd PDF jpg image extraction (fixes #2) (diff)
downloadkcc-d823afc3f931b31d963504e5fc3a8eb3a4b2932d.tar.gz
kcc-d823afc3f931b31d963504e5fc3a8eb3a4b2932d.tar.bz2
kcc-d823afc3f931b31d963504e5fc3a8eb3a4b2932d.zip
More work on GUI, added page number cut and other patches to image.py from proDOOMman and Birua (kudos in README)
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 949f2fc..a173db6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
 # KindleComicConverter
 
-`KindleComicConverter` is a Python app which aim is 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 Python app which aim is to convert comic files or folders to a comic-type (Mobipocket) ebook to take advantage of the new Panel View mode on Amazon's Kindle.
+
+## INPUT FORMATS
+`kcc` can understand and convert, at the moment, the following file types:  
+- CBZ, ZIP
+- CBR, RAR
+- flat folders
+- PDF *(extracting only contained JPG images)*  
+For now the script does not understand folder depth, so it will work on flat folders/archives only.
 
 ## REQUIREMENTS
 - `kindlegen` in /usr/local/bin/
@@ -47,7 +55,7 @@ The app relies and includes the following scripts/binaries:
  - 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
- - the `image.py` class from [Mangle](http://foosoft.net/mangle/)
+ - the `image.py` class from **Alex Yatskov**'s [Mangle](http://foosoft.net/mangle/) with subsequent [proDOOMman](https://github.com/proDOOMman/Mangle)'s and [Birua](https://github.com/Birua/Mangle)'s patches
 
 Also, you need to have `kindlegen` v2.7 (with KF8 support) which is downloadable from Amazon website
 and installed in `/usr/local/bin/`
@@ -72,4 +80,4 @@ and installed in `/usr/local/bin/`
 
 ## COPYRIGHT
 
-Copyright (c) 2012-2013 Ciro Mattia Gonano. See LICENSE.txt for further details.
\ No newline at end of file
+Copyright (c) 2012-2013 Ciro Mattia Gonano. See LICENSE.txt for further details.