Update README
This commit is contained in:
42
README.md
42
README.md
@@ -1,3 +1,41 @@
|
|||||||
# Z Reader
|
# Mokuro reader
|
||||||
|
|
||||||
A mokuro reader written in svelte
|
An online reader, gallery and stat tracker for [mokuro](https://github.com/kha-white/mokuro) processed manga.
|
||||||
|
|
||||||
|
|
||||||
|
## Features:
|
||||||
|
- Stat tracking (volumes read, pages read, characters read & minutes read)
|
||||||
|
- Extensive customization and profile support
|
||||||
|
- Anki connect integration & image cropping
|
||||||
|
- Installation and offline support
|
||||||
|
|
||||||
|
## Useage:
|
||||||
|
You can find the reader hosted [here](https://reader.mokuro.app/).
|
||||||
|
|
||||||
|
To import your manga, process it with mokuro and then upload your manga along with the generated `.mokuro` file.
|
||||||
|
|
||||||
|
As of the moment base mokuro does not generate the `.mokuro` file, you need to install and use `mokuro 0.2.0-beta.6`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install git+https://github.com/kha-white/mokuro.git@web-reader
|
||||||
|
```
|
||||||
|
|
||||||
|
Once installed and your manga is processed, import it your manga to the reader.
|
||||||
|
|
||||||
|
## Development:
|
||||||
|
|
||||||
|
Clone the repo:
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/ZXY101/mokuro-reader
|
||||||
|
cd mokuro-reader
|
||||||
|
```
|
||||||
|
|
||||||
|
Install dependencies:
|
||||||
|
```bash
|
||||||
|
npm run install
|
||||||
|
```
|
||||||
|
|
||||||
|
Start the dev server:
|
||||||
|
```bash
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user