Updated README

This commit is contained in:
Paweł Jastrzębski
2013-12-28 11:04:01 +01:00
parent c1c44bdf88
commit 93f5d105cf
2 changed files with 10 additions and 24 deletions
+4 -21
View File
@@ -27,7 +27,7 @@ You can find the latest released binary at the following links:
- **OS X (10.7 or earlier):** Soon™ - **OS X (10.7 or earlier):** Soon™
## INPUT FORMATS ## INPUT FORMATS
**KCC** can understand and convert, at the moment, the following file types: **KCC** can understand and convert, at the moment, the following input types:
- PNG, JPG, GIF, TIFF, BMP - PNG, JPG, GIF, TIFF, BMP
- Folders - Folders
- CBZ, ZIP - CBZ, ZIP
@@ -36,7 +36,7 @@ You can find the latest released binary at the following links:
- PDF *(Extracting only contained JPG images)* - PDF *(Extracting only contained JPG images)*
## OPTIONAL REQUIREMENTS ## OPTIONAL REQUIREMENTS
- [KindleGen](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211) v2.9+ in a directory reachable by your _PATH_ or in _KCC_ directory *(For .mobi generation)* - [KindleGen](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211) v2.9+ in a directory reachable by your _PATH_ or in _KCC_ directory *(For MOBI generation)*
- [UnRAR](http://www.rarlab.com/download.htm) *(For CBR/RAR support)* - [UnRAR](http://www.rarlab.com/download.htm) *(For CBR/RAR support)*
- [7za](http://www.7-zip.org/download.html) *(For 7z/CB7 support)* - [7za](http://www.7-zip.org/download.html) *(For 7z/CB7 support)*
@@ -49,28 +49,11 @@ You can find the latest released binary at the following links:
## USAGE ## USAGE
### Important tips:
* Use high quality source files. **This little detail have a major impact on the final result.**
* Read tooltip of _High/Ultra quality_ option. There are many important informations there.
* When converting images smaller than device resolution remember to enable upscaling.
* Panel View (auto zooming every part of page) can be disabled directly on Kindle. There is no KCC option to do that.
* Check our [wiki](https://github.com/ciromattia/kcc/wiki/Other-devices) for a list of tested Non-Kindle E-Readers.
* The first image found will be set as the comic's cover.
* All files/directories will be added to EPUB in alphabetical order.
* Using high/ultra quality output option with Kindle Fire HD/HDX in most cases is just waste of space.
* ComicRack metadata will be parsed only if they are saved in *ComicInfo.xml* file.
### Calibre:
* Calibre can be used to upload files created by KCC.
* Uploading KCC output with Calibre will remove *Personal* tag from cover.
* **Don't convert files created by KCC with Calibre!** Any conversion process will corrupt the file!
* Don't use Calibre reader to preview files created by KCC. It can't parse them correctly.
### GUI
Should be pretty self-explanatory. All options have detailed informations in tooltips. Should be pretty self-explanatory. All options have detailed informations in tooltips.
After completed conversion you should find ready file alongside the original input file (same directory). After completed conversion you should find ready file alongside the original input file (same directory).
Please check [our wiki](https://github.com/ciromattia/kcc/wiki/) for more details.
### Standalone `comic2ebook.py` usage: ### Standalone `comic2ebook.py` usage:
``` ```
+6 -3
View File
@@ -816,6 +816,9 @@ class KCCGUI(KCC_ui.Ui_KCC):
self.changeGamma(0) self.changeGamma(0)
if profile['DefaultUpscale']: if profile['DefaultUpscale']:
GUI.UpscaleBox.setChecked(True) GUI.UpscaleBox.setChecked(True)
if str(GUI.DeviceBox.currentText()) == 'Other':
self.addMessage('<a href="https://github.com/ciromattia/kcc/wiki/NonKindle-devices">'
'List of supported Non-Kindle devices.</a>', 'info')
def changeFormat(self, outputFormat=None): def changeFormat(self, outputFormat=None):
profile = GUI.profiles[str(GUI.DeviceBox.currentText())] profile = GUI.profiles[str(GUI.DeviceBox.currentText())]
@@ -1070,8 +1073,7 @@ class KCCGUI(KCC_ui.Ui_KCC):
statusBarLabel = QtGui.QLabel('<b><a href="http://kcc.vulturis.eu/">HOMEPAGE</a> - <a href="https://github.com/' statusBarLabel = QtGui.QLabel('<b><a href="http://kcc.vulturis.eu/">HOMEPAGE</a> - <a href="https://github.com/'
'ciromattia/kcc/blob/master/README.md#issues--new-features--donations">DONATE</a>' 'ciromattia/kcc/blob/master/README.md#issues--new-features--donations">DONATE</a>'
' - <a href="https://github.com/ciromattia/kcc/blob/master/README.md#kcc">README<' ' - <a href="https://github.com/ciromattia/kcc/wiki">WIKI</a></b>')
'/a> - <a href="https://github.com/ciromattia/kcc/wiki">WIKI</a></b>')
statusBarLabel.setAlignment(QtCore.Qt.AlignCenter) statusBarLabel.setAlignment(QtCore.Qt.AlignCenter)
statusBarLabel.setStyleSheet(self.statusBarStyle) statusBarLabel.setStyleSheet(self.statusBarStyle)
statusBarLabel.setOpenExternalLinks(True) statusBarLabel.setOpenExternalLinks(True)
@@ -1084,7 +1086,8 @@ class KCCGUI(KCC_ui.Ui_KCC):
self.addMessage('<b>Remember:</b> All options have additional informations in tooltips.', 'info') self.addMessage('<b>Remember:</b> All options have additional informations in tooltips.', 'info')
if self.firstStart: if self.firstStart:
self.addMessage('Since you are using <b>KCC</b> for first time please see few ' self.addMessage('Since you are using <b>KCC</b> for first time please see few '
'<a href="https://github.com/ciromattia/kcc#important-tips">important tips</a>.', 'info') '<a href="https://github.com/ciromattia/kcc/wiki/Important-tips">important tips</a>.',
'info')
kindleGenExitCode = Popen('kindlegen -locale en', stdout=PIPE, stderr=STDOUT, shell=True) kindleGenExitCode = Popen('kindlegen -locale en', stdout=PIPE, stderr=STDOUT, shell=True)
if kindleGenExitCode.wait() == 0: if kindleGenExitCode.wait() == 0:
self.KindleGen = True self.KindleGen = True