Commit b908d390 authored by njean42's avatar njean42
Browse files

Update doc for version 1.1 (python3, --debug-dir).

parent d317d132
......@@ -52,12 +52,12 @@ Read more in the [example Reader documentation](doc/Reader.md).
# Requirements
`apt-get install python-opencv` will install the only necessary library needed: *opencv* (3.x).
`apt-get install python3-opencv` will install the only necessary library needed: *opencv*.
This should do the trick for Debian distros and derivatives (Ubuntu, Linux Mint...).
If you successfully use *Kumiko* on any other platform, please let us know!
From memory (TODO: check), this implies using python version 2.x, since *opencv* 3.x runs on python 3.x.
*Kumiko* now uses python3.
......
......@@ -17,5 +17,3 @@ Use the left and right arrow keys or click-touch the screen to navigate through
## Reader implementation details
See the `reader.js` file for use in a browser or application webview.
Some event bindings are defined in the `xkcd.html` file.
......@@ -76,8 +76,8 @@ The image order is alphabetical, which is based on a commonly encountered *page0
## Debug
You can pass `kumiko` a `--debug` parameter that tells you are craving debugging information.
You can pass `kumiko` a `--debug-dir /path/to/debug-info` parameter that tells you are craving debugging information.
This will create an image for each page that Kumiko analysed, renamed `$filename-040-contours-numbers.jpg`.
These files will be found in the `debug` subfolder (should exist and be writable).
This will create an image for each page that Kumiko analysed, renamed `$filename-contours.jpg`.
These files will be found in the `/path/to/debug-info` folder (should exist and be writable).
Panel contours and image numbering is drawn onto every debugging image.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment