Commit 2533a062 authored by njean42's avatar njean42
Browse files

Update doc for coming v1.2

parent bc7c01df
......@@ -45,9 +45,7 @@ You read a page, possibly zooming on it to be able to read speech bubbles, then
With knowledge about panels locations, we can imagine a comic reader that also offers *panel-by-panel reading*.
This is especially interesting for **small screens**, on which you probably can't read the texts if a whole page is displayed.
We provide an example implementation of such a reader application.
Read more in the [example Reader documentation](doc/Reader.md).
Just run `kumiko -i /path/to/comicpage.jpg -b firefox` on your *comicpage.jpg* file, and read it panel-by-panel in your browser!
# Requirements
......
# Example of a panel-by-panel reader application
## Concept
We provide an example implementation of a *panel-by-panel reader* as an example of what *Kumiko* can be used for.
Once the command-line tool has generated a complete JSON representation (see the [usage doc](Usage.md)) of a page panels, our example reader can provide an interface that shows only the first (zoomed) panel of a page, and allows to jump forward to the next panel(s).
Try reading [an *xkcd* episode](../xkcd.html) panel by panel. :)
Use the left and right arrow keys or click-touch the screen to navigate through panels.
## Reader implementation details
See the `reader.js` file for use in a browser or application webview.
......@@ -11,18 +11,19 @@ To have an overview of the consequences of code changes, a testing tool is provi
Basically switch to `kumiko` top-level directory and run:
`./tester.py`
`./tester.py --html`
This will run *Kumiko*, your modified version, on all the comic page templates provided under `./tests/images/`.
But it will also run *Kumiko*'s previous version on the same files and calculate the differences!
But it will also run *Kumiko*'s previous version on the same files and check the differences!
# Results
An HTML file is generated under `./tests/results/` that you can open locally (add `--browser firefox` to open it automatically).
An HTML file is generated under `./tests/results/` that you can open locally (add `-b firefox` to open it automatically).
It will show you all the differences between the previous git version and yours!
Take a look at the [differences between *Kumiko* v1.0 and v1.1](https://kumiko-demo.njean.me/tests/results/diff-v1.0-v1.1.html).
Take a look at the differencs between *Kumiko* versions:
* [v1.11 and v1.1](https://kumiko-demo.njean.me/tests/results/diff-v1.1-v1.11.html)
* [v1.1 and v1.0](https://kumiko-demo.njean.me/tests/results/diff-v1.0-v1.1.html)
......@@ -11,6 +11,8 @@ More detailed help can be found by running `kumiko --help`.
kumiko -i /path/to/comicbook/page001.jpg
(Add `--html-debug -b firefox` to view the panels, on top of given image, in your browser!)
The result would look like the following:
[
......@@ -48,6 +50,8 @@ The `filename`s in our JSON object are relative to the working directory from wh
kumiko -i /path/to/comicbook/
(Add `--html-debug -b firefox` to view the panels for all pages, on top your images, in your browser!)
The result of such a command would be a JSON-formatted array of all images in the folder:
[
......
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