caribaud
/
melpomene
1
0
Fork 0
Code Issues 9 Pull Requests 1 Releases 3 Wiki Activity

Update 'README.md'

This commit is contained in:
caribaud 2023-05-19 18:09:17 +02:00
parent 7335afeff2
commit a5516c430f
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -29,6 +29,14 @@ flowchart TB
conf & html([HTML snipet]) & js([JS snipet]) & css([CSS snipet]) -- use / import into --> webpage([Your web page]) conf & html([HTML snipet]) & js([JS snipet]) & css([CSS snipet]) -- use / import into --> webpage([Your web page])
``` ```
## Limitations
The following limitations are known and will be improved upon :
+ Mobile support is currently limited
+ There are some performences issues
+ Your comic pages need to be the same size
# How to setup Melpomene ? # How to setup Melpomene ?
## Defining the zooms ## Defining the zooms
@ -72,6 +80,7 @@ You now need :
1. `melpomene_head.html` goes in the `head` tag of your page 1. `melpomene_head.html` goes in the `head` tag of your page
* You may need to change the `href` values to where you uploaded the CSS file. * You may need to change the `href` values to where you uploaded the CSS file.
2. `melpomene_reader.html` goes where you want somewhere within the `body` tag of your page 2. `melpomene_reader.html` goes where you want somewhere within the `body` tag of your page
* Change `data-pages-width` and `data-pages-height` with the actual width and height of your pages
* Change `https://link.to.my/comic/page.jpg` to the actual URL of your comic pages and duplicate the `img` * Change `https://link.to.my/comic/page.jpg` to the actual URL of your comic pages and duplicate the `img`
tag for each of them tag for each of them
3. `melpomene_js.html` goes right after the `body` tag of your page. 3. `melpomene_js.html` goes right after the `body` tag of your page.