public/kcc
1
0
Fork 0
mirror of https://github.com/ciromattia/kcc synced 2025-12-13 17:56:30 +00:00
Code Issues Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Ciro Mattia Gonano
2013-01-29 04:11:13 +01:00
parent 00504edadb
commit a12f98fac8
1 changed files with 9 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -20,7 +20,7 @@ You can find the latest released binary at the following links:
`kcc` can understand and convert, at the moment, the following file types: `kcc` can understand and convert, at the moment, the following file types:
- CBZ, ZIP - CBZ, ZIP
- CBR, RAR *(with `unrar` executable)* - CBR, RAR *(with `unrar` executable)*
- ~flat folders~ AT THE MOMENT `kcc` CAN NOT MANAGE FOLDERS! - folders
- PDF *(extracting only contained **JPG** images)* - PDF *(extracting only contained **JPG** images)*
~~For now the script does not understand folder depth, so it will work on flat folders/archives only.~~ ~~For now the script does not understand folder depth, so it will work on flat folders/archives only.~~
@@ -32,7 +32,7 @@ As of v. 1.50, KCC supports subfolders!
### for compiling/running from source: ### for compiling/running from source:
- Python 2.7+ (included in MacOS and Linux, follow the [official documentation](http://www.python.org/getit/windows/) to install on Windows) - Python 2.7+ (included in MacOS and Linux, follow the [official documentation](http://www.python.org/getit/windows/) to install on Windows)
- [Python Imaging Library](http://www.pythonware.com/products/pil/) for comic optimizations like split double pages, resize to optimal resolution, improve contrast and palette, etc. - [Pillow](http://pypi.python.org/pypi/Pillow/) for comic optimizations like split double pages, resize to optimal resolution, improve contrast and palette, etc.
Please refer to official documentation for installing into your system. Please refer to official documentation for installing into your system.
## USAGE ## USAGE
@@ -67,34 +67,24 @@ comic2ebook.py [options] comic_file|comic_folder
[default=True] [default=True]
``` ```
The script takes care of unzipping/unrarring the file if it's an archive, creating a directory of images which should be then filled with a `.opf`, `.ncx`, and many `.html` files, then: The script takes care of creating an *.epub* from your archive/folder, then:
1. Run `Kindlegen` on `content.opf`. Depending on how many images you have, this may take awhile. Once completed, the `.mobi` file should be in the directory. 1. Run `Kindlegen` on the generated *.epub*. Depending on how many images you have, this may take awhile. Once completed, the `.mobi` file should be in the directory.
2. (optionally) remove the SRCS record to reduce the `.mobi` filesize in half. You can use [Kindlestrip](http://www.mobileread.com/forums/showthread.php?t=96903). 2. (optionally) remove the SRCS record to reduce the `.mobi` filesize in half. You can use [Kindlestrip](http://www.mobileread.com/forums/showthread.php?t=96903).
3. Copy the `.mobi` file to your Kindle! 3. Copy the `.mobi` file to your Kindle!
### AppleScript Droplet (may be outdated)
Drop a folder or a CBZ/CBR file over the app, 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 droplet *ALWAYS* uses the **KHD** profile (*Kindle Paperwhite*).
> If you want to specify other profiles, please use the script from command line.
## CREDITS ## CREDITS
This script born as a cross-platform alternative to `KindleComicParser` by **Dc5e** (published in [this mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=192783)) This script born as a cross-platform alternative to `KindleComicParser` by **Dc5e** (published in [this mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=192783))
The app relies and includes the following scripts/binaries: The app relies and includes the following scripts/binaries:
- the `KindleStrip` script © 2010-2012 by **Paul Durrant** and released in public domain - `KindleStrip` script © 2010-2012 by **Paul Durrant** and released in public domain
([mobileread forum thread](http://www.mobileread.com/forums/showthread.php?t=96903)) ([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 - `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 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 **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 - `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 Also, for .mobi generation you need to have `kindlegen` v2.7 (with KF8 support) which is downloadable from Amazon website
and installed in `/usr/local/bin/` and installed in a directory reachable by your PATH (e.g. `/usr/local/bin/` or `C:\Windows\`)
## CHANGELOG ## CHANGELOG
@@ -122,7 +112,6 @@ and installed in `/usr/local/bin/`
- Improve GUI displaying what file we're processing and giving an explicit progress status - Improve GUI displaying what file we're processing and giving an explicit progress status
- Better GUI design - Better GUI design
- Make window take focus on app launch - Make window take focus on app launch
- [OSX] Finder-launched app does not take into account user local $PATH
## COPYRIGHT ## COPYRIGHT