mirror of
https://github.com/YunoHost-Apps/kavita_ynh.git
synced 2024-09-03 19:26:30 +02:00
Merge branch 'master' of https://github.com/YunoHost-Apps/kavita_ynh
This commit is contained in:
Éric Gaspar
commit
f3138cf452
2 changed files with 96 additions and 55 deletions
81
README.md
81
README.md
|
|
@ -1,49 +1,65 @@
|
|||
# Packaging an app, starting from this example
|
||||
|
||||
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
||||
* Edit the `manifest.json` with app specific info.
|
||||
* Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
|
||||
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
|
||||
* Add a `LICENSE` file for the package.
|
||||
* Edit `doc/DISCLAIMER*.md`
|
||||
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
|
||||
---
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Example app for YunoHost
|
||||
# Kavita for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/kavita)  
|
||||
[](https://install-app.yunohost.org/?app=kavita)
|
||||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Example app quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install Kavita quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
|
||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||
Kavita is a fast, feature rich, cross platform reading server. Built with a focus for manga and the goal of being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family.
|
||||
|
||||
### Features
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
- Extensive File support
|
||||
- Manga/Comics: ZIP, RAR, CBR, CBZ, CB7, CBT, TAR.GZ, 7ZIP/7Z
|
||||
- Books: EPUB2, EPUB3, PDF
|
||||
- Raw Images: JPG/JPEG, PNG, WEBP
|
||||
- Manga/Comic Reader
|
||||
- Image Scaling to fit your device screen or override for what feels best to you
|
||||
- Image Splitting for those joined page spreads, don't scroll on your tablet, just split
|
||||
- Apply a custom dark or sepia tone to your images to make it easier to read at night
|
||||
- Reading Direction: Left/Right, Up/Down, Webtoon
|
||||
- Webtoon reader built-in
|
||||
- Read across archives without closing the reader
|
||||
- Book Reader
|
||||
- Interactive reader - can interact with text, run javascript
|
||||
- Dark mode persists between page load
|
||||
- Can tap to paginate or use dedicated buttons
|
||||
- Customize your reading experience with custom Font, Font Size, Margin, Reading Direction, Dark Mode
|
||||
- Table of Content just a click away
|
||||
- Remember line position and resume where you left off, no matter the device
|
||||
- Read across books without closing the reader
|
||||
- User Management and Sharing
|
||||
Create users and share your libraries with them
|
||||
Grant users permissions to view libraries or see different mixed-media collections
|
||||
Built-in ratings and reviews for each of your users
|
||||
- Cross Platform with no dependencies - Everything in the box
|
||||
- Responsive and Fast!
|
||||
- Full-text search to quickly find what you want to read
|
||||
- Mixed media Libraries - Light Novels and Manga can be right next to each other
|
||||
- Fast and efficient library scans. Don't perform I/O if the underlying file hasn't changed.
|
||||
- Accessibility first - audits for color contrast, screen reader, and keyboard only
|
||||
- OPDS-PS Support
|
||||
- Frequent updates with new features
|
||||
|
||||
|
||||
**Shipped version:** 1.0~ynh1
|
||||
|
||||
**Demo:** https://demo.example.com
|
||||
**Shipped version:** 0.6.1~ynh1
|
||||
|
||||
**Demo:** https://demo.kavitareader.com/
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
|
|
@ -62,23 +78,22 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
|||
|
||||
## Documentation and resources
|
||||
|
||||
* Official app website: <https://example.com>
|
||||
* Official user documentation: <https://yunohost.org/apps>
|
||||
* Official admin documentation: <https://yunohost.org/packaging_apps>
|
||||
* Upstream app code repository: <https://some.forge.com/example/example>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_example>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Official app website: <www.kavitareader.com>
|
||||
* Official admin documentation: <https://wiki.kavitareader.com/en>
|
||||
* Upstream app code repository: <https://github.com/Kareadita/Kavita>
|
||||
* YunoHost documentation for this app: <https://yunohost.org/app_kavita>
|
||||
* Report a bug: <https://github.com/YunoHost-Apps/kavita_ynh/issues>
|
||||
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kavita_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
70
README_fr.md
70
README_fr.md
|
|
@ -3,36 +3,63 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
|
|||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Exemple d'app pour YunoHost
|
||||
# Kavita pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/example)  
|
||||
[](https://install-app.yunohost.org/?app=example)
|
||||
[](https://dash.yunohost.org/appci/app/kavita)  
|
||||
[](https://install-app.yunohost.org/?app=kavita)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost.
|
||||
> *Ce package vous permet d'installer Kavita rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||
Kavita is a fast, feature rich, cross platform reading server. Built with a focus for manga and the goal of being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family.
|
||||
|
||||
### Features
|
||||
|
||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
||||
- Extensive File support
|
||||
- Manga/Comics: ZIP, RAR, CBR, CBZ, CB7, CBT, TAR.GZ, 7ZIP/7Z
|
||||
- Books: EPUB2, EPUB3, PDF
|
||||
- Raw Images: JPG/JPEG, PNG, WEBP
|
||||
- Manga/Comic Reader
|
||||
- Image Scaling to fit your device screen or override for what feels best to you
|
||||
- Image Splitting for those joined page spreads, don't scroll on your tablet, just split
|
||||
- Apply a custom dark or sepia tone to your images to make it easier to read at night
|
||||
- Reading Direction: Left/Right, Up/Down, Webtoon
|
||||
- Webtoon reader built-in
|
||||
- Read across archives without closing the reader
|
||||
- Book Reader
|
||||
- Interactive reader - can interact with text, run javascript
|
||||
- Dark mode persists between page load
|
||||
- Can tap to paginate or use dedicated buttons
|
||||
- Customize your reading experience with custom Font, Font Size, Margin, Reading Direction, Dark Mode
|
||||
- Table of Content just a click away
|
||||
- Remember line position and resume where you left off, no matter the device
|
||||
- Read across books without closing the reader
|
||||
- User Management and Sharing
|
||||
Create users and share your libraries with them
|
||||
Grant users permissions to view libraries or see different mixed-media collections
|
||||
Built-in ratings and reviews for each of your users
|
||||
- Cross Platform with no dependencies - Everything in the box
|
||||
- Responsive and Fast!
|
||||
- Full-text search to quickly find what you want to read
|
||||
- Mixed media Libraries - Light Novels and Manga can be right next to each other
|
||||
- Fast and efficient library scans. Don't perform I/O if the underlying file hasn't changed.
|
||||
- Accessibility first - audits for color contrast, screen reader, and keyboard only
|
||||
- OPDS-PS Support
|
||||
- Frequent updates with new features
|
||||
|
||||
|
||||
**Version incluse :** 1.0~ynh1
|
||||
|
||||
**Démo :** https://demo.example.com
|
||||
**Version incluse :** 0.6.1~ynh1
|
||||
|
||||
**Démo :** https://demo.kavitareader.com/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
|
|
@ -51,23 +78,22 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
|||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : <https://example.com>
|
||||
* Documentation officielle utilisateur : <https://yunohost.org/apps>
|
||||
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
|
||||
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
|
||||
* Site officiel de l'app : <www.kavitareader.com>
|
||||
* Documentation officielle de l'admin : <https://wiki.kavitareader.com/en>
|
||||
* Dépôt de code officiel de l'app : <https://github.com/Kareadita/Kavita>
|
||||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_kavita>
|
||||
* Signaler un bug : <https://github.com/YunoHost-Apps/kavita_ynh/issues>
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kavita_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
|
||||
``` bash
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue