about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md154
1 files changed, 83 insertions, 71 deletions
diff --git a/README.md b/README.md
index d1c8ea8..a06ad77 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# KCC
+# KCC
+
+[![GitHub release](https://img.shields.io/github/release/ciromattia/kcc.svg)]() [![PyPI](https://img.shields.io/pypi/v/KindleComicConverter.svg)]() [![AUR](https://img.shields.io/aur/version/kcc.svg)]()
 
 **Kindle Comic Converter** is a Python app to convert comic/manga files or folders to EPUB, Panel View MOBI or E-Ink optimized CBZ.
 It was initially developed for Kindle but since version 4.6 it outputs valid EPUB 3.0 so _**despite its name, KCC is
@@ -17,11 +19,11 @@ If you can fix an open issue, fork & make a pull request.
 
 If you find **KCC** valuable you can consider donating to the authors:
 - Ciro Mattia Gonano:
- - [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D8WNYNPBGDAS2)
- - [![Flattr this](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/2260449/ciromattiakcc-on-GitHub)
+  - [![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=D8WNYNPBGDAS2)
+  - [![Donate Flattr](https://img.shields.io/badge/Donate-Flattr-green.svg)](http://flattr.com/thing/2260449/ciromattiakcc-on-GitHub)
 - Paweł Jastrzębski:
- - [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YTTJ4LK2JDHPS)
- - Bitcoin: 1W15wwqsfd7wbaZ6wvSJf1LW1bz6q5L8b
+  - [![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YTTJ4LK2JDHPS)
+  - [![Donate Bitcoin](https://img.shields.io/badge/Donate-Bitcoin-green.svg)](https://jastrzeb.ski/donate/)
 
 ## BINARY RELEASES
 You can find the latest released binary at the following links:
@@ -29,20 +31,25 @@ You can find the latest released binary at the following links:
 - **Linux (Glibc 2.19+):** [http://kcc.iosphe.re/Linux/](http://kcc.iosphe.re/Linux/)
 - **OS X (10.9+):** [http://kcc.iosphe.re/OSX/](http://kcc.iosphe.re/OSX/)
 
+## PYPI
+**KCC** is also available on PyPI.
+```
+pip install KindleComicConverter
+```
+
 ## DEPENDENCIES
 Following software is required to run Linux version of **KCC** and/or bare sources:
 - Python 3.3+
-- [PyQt](https://pypi.python.org/pypi/PyQt5) 5.6.0+
-- [Pillow](https://pypi.python.org/pypi/Pillow/) 3.2.0+
-- [psutil](https://pypi.python.org/pypi/psutil) 4.1.0+
-- [python-slugify](https://pypi.python.org/pypi/python-slugify) 1.2.0+
-- [raven](https://pypi.python.org/pypi/raven) 5.13.0+
-- [scandir](https://pypi.python.org/pypi/scandir) 1.2.0+ _(needed only when using Python 3.3 or 3.4)_
+- [PyQt5](https://pypi.python.org/pypi/PyQt5) 5.6.0+
+- [Pillow](https://pypi.python.org/pypi/Pillow/) 4.0.0+
+- [psutil](https://pypi.python.org/pypi/psutil) 5.0.0+
+- [python-slugify](https://pypi.python.org/pypi/python-slugify) 1.2.1+
+- [raven](https://pypi.python.org/pypi/raven) 6.0.0+
 
 On Debian based distributions these two commands should install all needed dependencies:
 ```
 sudo apt-get install python3 python3-dev python3-pip libpng-dev libjpeg-dev p7zip-full unrar
-sudo pip3 install --upgrade pillow python-slugify psutil scandir raven pyqt5
+sudo pip3 install --upgrade pillow python-slugify psutil pyqt5 raven
 ```
 
 ### Optional dependencies
@@ -163,35 +170,40 @@ The app relies and includes the following scripts:
 * [Kobo Aura ONE](http://kcc.iosphe.re/Samples/Ubunchu-KoAO.kepub.epub)
 
 ## CHANGELOG
-####5.3:
+#### 5.3.1:
+* Small increase of output quality
+* Improved error reporting
+* Internal changes and tweaks
+
+#### 5.3:
 * Vastly improved output compatibility for non-Kindle devices
 * Enabled old pinch zoom for Kindle devices
 * Re-enabled Panel View support for Kindle Keyboard
 * Partially re-enabled OS X file association mechanism
 * Fixed multiple smaller issues
 
-####5.2.1:
+#### 5.2.1:
 * Improved directory parsing
 * Tweaked margin detection algorithm
 * Improved error reporting
 
-####5.2:
+#### 5.2:
 * Added new Panel View options
 * Implemented new margin detection algorithm
 * Removed HQ Panel View mode
 * Fixed multiple smaller issues
 
-####5.1.3:
+#### 5.1.3:
 * Added Kobo Aura ONE profile
 * Fixed few small bugs
 
-####5.1.2:
+#### 5.1.2:
 * Fixed error reporting
 
-####5.1.1:
+#### 5.1.1:
 * Fixed multiple GUI bugs
 
-####5.1:
+#### 5.1:
 * GUI now can be resized and high DPI support was somewhat improved
 * Added profile for Kindle Oasis
 * Implemented new error reporting mechanism
@@ -199,55 +211,55 @@ The app relies and includes the following scripts:
 * Fixed permission issues on Windows
 * Fixed multiple smaller issues
 
-####5.0.1:
+#### 5.0.1:
 * Fixed Panel View placement issues
 * Decreased application startup time
 * Fixed multiple smaller issues
 
-####5.0:
+#### 5.0:
 * Major overhaul of internal mechanisms and GUI
 * Added cover upload feature
 * Tweaked Webtoon parsing mode
 * Fixed multiple smaller issues
 * Migrated build enviroment to PyInstaller
 
-####4.6.5:
+#### 4.6.5:
 * Fixed multiple Windows and OS X issues
 * Allowed Linux release to use older PyQT5 version
 
-####4.6.4:
+#### 4.6.4:
 * Fixed multiple Windows specific problems
 * Improved error handling
 * Improved color detection algorithm
 * New, slimmer OS X release
 
-####4.6.3:
+#### 4.6.3:
 * Implemented remote bug reporting
 * Minor bug fixes and GUI tweaks
 
-####4.6.2:
+#### 4.6.2:
 * Fixed critical MOBI header bug
 * Fixed metadata encoding error
 
-####4.6.1:
+#### 4.6.1:
 * Fixed KEPUB TOC generator
 * Added warning about too small input files
 * ComicRack Summary metadata field is now parsed
 * Small tweaks of KEPUB output
 
-####4.6:
+#### 4.6:
 * KEPUB is now default output for all Kobo profiles
 * EPUB output now produce fully valid EPUB 3.0.1
 * Added profile for Kindle Paperwhite 3
 * Dropped official support of all Kindle Fire models and Kindle for Android
 * Other minor tweaks
 
-####4.5.1:
+#### 4.5.1:
 * Added Kobo Glo HD profile
 * Fixed RAR/CBR parsing anomalies
 * Minor bug fixes and tweaks
 
-####4.5:
+#### 4.5:
 * Added simple ComicRack metadata editor
 * Re-enabled Manga Cover Database support
 * ComicRack bookmarks are now parsed
@@ -256,61 +268,61 @@ The app relies and includes the following scripts:
 * Fixed sorting anomalies
 * Improved conversion speed
 
-####4.4.1:
+#### 4.4.1:
 * Fixed problems with OSX GUI
 * Added one missing DLL to Windows installer
 
-####4.4:
+#### 4.4:
 * Improved speed and quality of conversion
 * Added RAR5 support
 * Dropped BMP and TIFF support
 * Fixed some WebToon mode bugs
 * Fixed CBR parsing on OSX
 
-####4.3.1:
+#### 4.3.1:
 * Fixed Kindle Voyage profile
 * Fixed some bugs in OS X release
 * CLI version now support multiple input files at once
 * Disabled MCB support
 * Other minor tweaks
 
-####4.3:
+#### 4.3:
 * Added profiles for Kindle Voyage and Kobo Aura H2O
 * Added missing features to CLI version
 * Other minor bug fixes
 
-####4.2.1:
+#### 4.2.1:
 * Improved margin color detection 
 * Fixed random crashes of MOBI processing step
 * Fixed resizing problems in high quality mode
 * Fixed some MCD support bugs
 * Default output format for Kindle DX is now CBZ
 
-####4.2:
+#### 4.2:
 * Added [Manga Cover Database](http://manga.joentjuh.nl/) support
 * Officially dropped Windows XP support
 * Fixed _Other_ profile
 * Fixed problems with page order on stock KOBO CBZ reader
 * Many other small bug fixes and tweaks
 
-####4.1:
+#### 4.1:
 * Thanks to code contributed by Kevin Hendricks speed of MOBI creation was greatly increased
 * Improved performance on Windows
 * Improved MOBI splitting and changed maximal size of output file
 * Fixed _No optimization_ mode
 * Multiple small tweaks nad minor bug fixes
 
-####4.0.2:
+#### 4.0.2:
 * Fixed some Windows and OSX specific bugs
 * Fixed problem with marigns when using HQ mode
 
-####4.0.1:
+#### 4.0.1:
 * Fixed file lock problems that plagued some Windows users
 * Fixed content server failing to start on Windows
 * Improved performance of WebToon splitter
 * Tweaked margin color detection
 
-####4.0:
+#### 4.0:
 * KCC now use Python 3.3 and Qt 5.2
 * Full UTF-8 awareness
 * CBZ output now support Manga mode
@@ -322,13 +334,13 @@ The app relies and includes the following scripts:
 * Fixed OSX file association support
 * Many extensive internal changes and tweaks
 
-####3.7.2:
+#### 3.7.2:
 * Fixed problems with HQ mode
 
-####3.7.1:
+#### 3.7.1:
 * Hotfixed Kobo profiles
 
-####3.7:
+#### 3.7:
 * Added profiles for KOBO devices
 * Improved Panel View support
 * Improved WebToon splitter
@@ -337,14 +349,14 @@ The app relies and includes the following scripts:
 * Fixed stretching option
 * GUI tweaks and minor bugfixes
 
-####3.6.2:
+#### 3.6.2:
 * Fixed previous PNG output fix
 * Fixed Panel View anomalies
 
-####3.6.1:
+#### 3.6.1:
 * Fixed PNG output
 
-####3.6:
+#### 3.6:
 * Increased quality of Panel View zoom
 * Creation of multipart MOBI output is now faster on machines with 4GB+ RAM
 * Automatic gamma correction now distinguishes color and grayscale images
@@ -355,13 +367,13 @@ The app relies and includes the following scripts:
 * Fixed Kindle Fire HDX 7" output
 * Increased target resolution for Kindle DX/DXG CBZ output
 
-####3.5:
+#### 3.5:
 * Added simple content server - Converted files can be now delivered wireless
 * Added proper Windows installer
 * Improved multiprocessing speed
 * GUI tweaks and minor bug fixes
 
-####3.4:
+#### 3.4:
 * Improved PNG output
 * Increased quality of upscaling
 * Added support of file association - KCC can now open CBZ, CBR, CB7, ZIP, RAR, 7Z and PDF files directly
@@ -370,7 +382,7 @@ The app relies and includes the following scripts:
 * Merged DX and DXG profiles
 * Many other minor bug fixes and GUI tweaks
 
-####3.3:
+#### 3.3:
 * Margins are now automatically omitted in Panel View mode
 * Margin color fill is now autodetected
 * Created MOBI files are not longer marked as _Personal_ on newer Kindle models
@@ -384,27 +396,27 @@ The app relies and includes the following scripts:
 * Windows release is now bundled with UnRAR and 7za
 * Small GUI tweaks
 
-####3.2:
+#### 3.2:
 * Too big EPUB files are now splitted before conversion to MOBI
 * Added experimental parser of manga webtoons
 * Improved error handling
 
-####3.2.1:
+#### 3.2.1:
 * Hotfixed crash occurring on OS with Russian locale
 
-####3.1:
+#### 3.1:
 * Added profile: Kindle for Android
 * Add file/directory dialogs now support multiselect
 * Many small fixes and tweaks
 
-####3.0:
+#### 3.0:
 * New QT GUI
 * Merge with AWKCC
 * Added ultra quality mode
 * Added support for custom width/height
 * Added option to disable color conversion
 
-####2.10:
+#### 2.10:
 * Multiprocessing support
 * Kindle Fire support (color EPUB/MOBI)
 * Panel View support for horizontal content
@@ -412,14 +424,14 @@ The app relies and includes the following scripts:
 * Disabled cropping and page number cutting for blank pages
 * Fixed some slugify issues with specific file naming conventions (#50, #51)
 
-####2.9
+#### 2.9
 * Added support for generating a plain CBZ (skipping all the EPUB/MOBI generation) (#45)  
 * Prevent output file overwriting the source one: if a duplicate name is detected, append _kcc to the name  
 * Rarfile library updated to 2.6  
 * Added GIF, TIFF and BMP to supported formats (#42)  
 * Filenames slugifications (#28, #31, #9, #8)
 
-####2.8
+#### 2.8
 * Updated rarfile library  
 * Panel View support + HQ support (#36) - new option: --nopanelviewhq
 * Split profiles for K4NT and K4T  
@@ -428,7 +440,7 @@ The app relies and includes the following scripts:
 * Added generic CSS file  
 * Optimized archive extraction for zip/rar files (#40)  
 
-####2.7
+#### 2.7
 * Lots of GUI improvements (#27, #13)  
 * Added gamma support within --gamma option (defaults to profile-specified gamma) (#26, #27)  
 * Added --nodithering option to prevent dithering optimizations (#27)  
@@ -439,57 +451,57 @@ The app relies and includes the following scripts:
 * Get filetype from magic number (#14)   
 * PDF conversion works again  
 
-####2.6
+#### 2.6
 * Added --rotate option to rotate landscape images instead of splitting them (#16, #24)  
 * Added --output option to customize EPUB output dir/file (#22)  
 * Add rendition:layout and rendition:orientation EPUB meta tags (supported by new kindlegen 2.8)  
 * Fixed natural sorting for files (#18)
 
-####2.5
+#### 2.5
 * Added --black-borders option to set added borders black when page's ratio is not the device's one (#11).  
 * Fixes EPUB containing zipped itself (#10)  
 
-####2.4
+#### 2.4
 * Use temporary directory as workdir (fixes converting from external volumes and zipfiles renaming)  
 * Fixed "add folders" from GUI.
 
-####2.3
+#### 2.3
 * Fixed win32 EPUB generation, folder handling, filenames with spaces and subfolders
 
-####2.2:
+#### 2.2:
 * Added (valid!) EPUB 2.0 output  
 * Rename .zip files to .cbz to avoid overwriting
 
-####2.1
+#### 2.1
 * Added basic error reporting
 
-####2.0
+#### 2.0
 * GUI! AppleScript is gone and Tk is used to provide cross-platform GUI support.
 
-####1.5
+#### 1.5
 * Added subfolder support for multiple chapters.
 
-####1.4.1
+#### 1.4.1
 * Fixed a serious bug on resizing when img ratio was bigger than device one
 
-####1.4
+#### 1.4
 * Added some options for controlling image optimization  
 * Further optimization (ImageOps, page numbering cut, autocontrast)
 
-####1.3
+#### 1.3
 * Fixed an issue in OPF generation for device resolution  
 * Reworked options system (call with -h option to get the inline help)
 
-####1.2
+#### 1.2
 * Comic optimizations! Split pages not target-oriented (landscape with portrait target or portrait with landscape target), add palette and other image optimizations from Mangle. WARNING: PIL is required for all image mangling!
 
-####1.1.1
+#### 1.1.1
 * Added support for CBZ/CBR files in Kindle Comic Converter
 
-####1.1
+#### 1.1
 * Added support for CBZ/CBR files in comic2ebook.py
 
-####1.0
+#### 1.0
 * Initial version
 
 ## PRIVACY