diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..a01b345 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index bd8f286..18e2509 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install Kavita with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kavita) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README in other languages.](./ALL_README.md)* -> *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.* +> *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 @@ -31,14 +31,18 @@ Kavita is a fast, feature rich, cross platform reading server. Built with a focu - OPDS-PS Support -**Shipped version:** 0.7.14~ynh1 +**Shipped version:** 0.8.0~ynh1 -**Demo:** https://demo.kavitareader.com/ +**Demo:** ## Screenshots ![Screenshot of Kavita](./doc/screenshots/screenshot.png) +## :red_circle: Antifeatures + +- **Paid content**: Promotes or depends, entirely or partially, on a paid service. + ## Documentation and resources - Official app website: @@ -49,11 +53,11 @@ Kavita is a fast, feature rich, cross platform reading server. Built with a focu ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/kavita_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. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug or sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..dcebf74 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,66 @@ + + +# Kavita YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/kavita.svg)](https://dash.yunohost.org/appci/app/kavita) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/kavita.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/kavita.maintain.svg) + +[![Instalatu Kavita YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kavita) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Kavita YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +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 + +- Extensive File support +- Manga/Comic Reader +- Book Reader +- User Management and Sharing +- Cross Platform with no dependencies - Everything in the box +- 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. +- OPDS-PS Support + + +**Paketatutako bertsioa:** 0.8.0~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![Kavita(r)en pantaila-argazkia](./doc/screenshots/screenshot.png) + +## :red_circle: Ezaugarri zalantzagarriak + +- **Ordainpeko edukia**: Ordainpeko zerbitzu bat sustatzen du edo bere mende dago, osorik edo neurri batean. + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/kavita_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +edo +sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 016c974..77a1ac0 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Kavita pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer Kavita avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kavita) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *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.* +> *Ce package vous permet d’installer Kavita rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -30,32 +30,36 @@ Kavita est un serveur de lecture multiplateforme rapide et riche en fonctionnali - Analyses de bibliothèque rapides et efficaces. N'effectuez pas d'E/S si le fichier sous-jacent n'a pas changé. - Prise en charge OPDS-PS -**Version incluse :** 0.7.14~ynh1 +**Version incluse :** 0.8.0~ynh1 -**Démo :** https://demo.kavitareader.com/ +**Démo :** ## Captures d’écran ![Capture d’écran de Kavita](./doc/screenshots/screenshot.png) +## :red_circle: Anti-fonctionnalités + +- **Contenu payant **: Promeut ou dépend, entièrement ou partiellement, d'un service payant. + ## Documentations et ressources -- Site officiel de l’app : -- Documentation officielle de l’admin : -- Dépôt de code officiel de l’app : -- YunoHost Store : -- Signaler un bug : +- Site officiel de l’app : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/kavita_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. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug ou sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..8986729 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,66 @@ + + +# Kavita para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/kavita.svg)](https://dash.yunohost.org/appci/app/kavita) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/kavita.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/kavita.maintain.svg) + +[![Instalar Kavita con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kavita) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Kavita de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +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 + +- Extensive File support +- Manga/Comic Reader +- Book Reader +- User Management and Sharing +- Cross Platform with no dependencies - Everything in the box +- 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. +- OPDS-PS Support + + +**Versión proporcionada:** 0.8.0~ynh1 + +**Demo:** + +## Capturas de pantalla + +![Captura de pantalla de Kavita](./doc/screenshots/screenshot.png) + +## :red_circle: Caraterísticas cuestionables + +- **Paid content**: Promotes or depends, entirely or partially, on a paid service. + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/kavita_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +ou +sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 0000000..b76df3b --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,66 @@ + + +# YunoHost 的 Kavita + +[![集成程度](https://dash.yunohost.org/integration/kavita.svg)](https://dash.yunohost.org/appci/app/kavita) ![工作状态](https://ci-apps.yunohost.org/ci/badges/kavita.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/kavita.maintain.svg) + +[![使用 YunoHost 安装 Kavita](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=kavita) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Kavita。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +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 + +- Extensive File support +- Manga/Comic Reader +- Book Reader +- User Management and Sharing +- Cross Platform with no dependencies - Everything in the box +- 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. +- OPDS-PS Support + + +**分发版本：** 0.8.0~ynh1 + +**演示：** + +## 截图 + +![Kavita 的截图](./doc/screenshots/screenshot.png) + +## :red_circle: 负面特征 + +- **Paid content**: Promotes or depends, entirely or partially, on a paid service. + +## 文档与资源 + +- 官方应用网站： +- 官方管理文档： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/kavita_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +或 +sudo yunohost app upgrade kavita -u https://github.com/YunoHost-Apps/kavita_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**