YunoHost-Apps/bookwyrm_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/bookwyrm_ynh.git synced 2024-09-03 18:16:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update READMEs

Browse source
This commit is contained in:
Salamandar 2024-06-23 13:28:52 +02:00
parent eaa5f3d6ff
commit 62f3efe6af
7 changed files with 261 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ALL_README.md Normal file
View file

@ -0,0 +1,8 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lea el README en español](README_es.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)

28
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was 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. It shall NOT be edited by hand.
--> -->
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
[![Install BookWyrm with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm) [![Install BookWyrm with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[Lire ce readme en français.](./README_fr.md)* *[Read this README in other languages.](./ALL_README.md)*
> *This package allows you to install BookWyrm quickly and simply on a YunoHost server. > *This package allows you to install BookWyrm 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.* > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview ## Overview
@ -21,25 +21,29 @@ BookWyrm is a social network for tracking your reading, talking about books, wri
**Shipped version:** 0.7.2~ynh1 **Shipped version:** 0.7.2~ynh1
**Demo:** https://joinbookwyrm.com/fr/ **Demo:** <https://joinbookwyrm.com/fr/>
## Screenshots ## Screenshots
![Screenshot of BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg) ![Screenshot of BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: Antifeatures
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
## Documentation and resources ## Documentation and resources
* Official app website: <https://joinbookwyrm.com/fr/> - Official app website: <https://joinbookwyrm.com/fr/>
* Official admin documentation: <https://docs.joinbookwyrm.com/> - Official admin documentation: <https://docs.joinbookwyrm.com/>
* Upstream app code repository: <https://github.com/bookwyrm-social/bookwyrm> - Upstream app code repository: <https://github.com/bookwyrm-social/bookwyrm>
* YunoHost Store: <https://apps.yunohost.org/app/bookwyrm> - YunoHost Store: <https://apps.yunohost.org/app/bookwyrm>
* Report a bug: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues> - Report a bug: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing). Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/bookwyrm_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/bookwyrm_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug

54
README_es.md Normal file
View file

@ -0,0 +1,54 @@
<!--
Este archivo README esta generado automaticamente<https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
No se debe editar a mano.
-->
# BookWyrm para Yunohost
[![Nivel de integración](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
[![Instalar BookWyrm con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[Leer este README en otros idiomas.](./ALL_README.md)*
> *Este paquete le permite instalarBookWyrm rapidamente y simplement en un servidor YunoHost.*
> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.*
## Descripción general
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
**Versión actual:** 0.7.2~ynh1
**Demo:** <https://joinbookwyrm.com/fr/>
## Capturas
![Captura de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: Características no deseables
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
## Documentaciones y recursos
- Sitio web oficial: <https://joinbookwyrm.com/fr/>
- Documentación administrador oficial: <https://docs.joinbookwyrm.com/>
- Repositorio del código fuente oficial de la aplicación : <https://github.com/bookwyrm-social/bookwyrm>
- Catálogo YunoHost: <https://apps.yunohost.org/app/bookwyrm>
- Reportar un error: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Información para desarrolladores
Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing
Para probar la rama `testing`, sigue asÍ:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
o
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
```
**Mas informaciones sobre el empaquetado de aplicaciones:** <https://yunohost.org/packaging_apps>

54
README_eu.md Normal file
View file

@ -0,0 +1,54 @@
<!--
Ohart ongi: README hau automatikoki sortu da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>ri esker
EZ editatu eskuz.
-->
# BookWyrm YunoHost-erako
[![Integrazio maila](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
[![Instalatu BookWyrm YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)*
> *Pakete honek BookWyrm YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.*
> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.*
## Aurreikuspena
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
**Paketatutako bertsioa:** 0.7.2~ynh1
**Demoa:** <https://joinbookwyrm.com/fr/>
## Pantaila-argazkiak
![BookWyrm(r)en pantaila-argazkia](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: Ezaugarri zalantzagarriak
- **Jatorrizkoa ez da erabat librea**: Aplikazioak lizentzia librea du orokorrean, baina bere erabilera mugatzen duten klausulekin.
## Dokumentazioa eta baliabideak
- Aplikazioaren webgune ofiziala: <https://joinbookwyrm.com/fr/>
- Administratzaileen dokumentazio ofiziala: <https://docs.joinbookwyrm.com/>
- Jatorrizko aplikazioaren kode-gordailua: <https://github.com/bookwyrm-social/bookwyrm>
- YunoHost Denda: <https://apps.yunohost.org/app/bookwyrm>
- Eman errore baten berri: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Garatzaileentzako informazioa
Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing).
`testing` abarra probatzeko, ondorengoa egin:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
edo
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
```
**Informazio gehiago aplikazioaren paketatzeari buruz:** <https://yunohost.org/packaging_apps>

34
README_fr.md
View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# BookWyrm pour YunoHost # BookWyrm pour YunoHost
@ -9,37 +9,41 @@ It shall NOT be edited by hand.
[![Installer BookWyrm avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm) [![Installer BookWyrm avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[Read this readme in english.](./README.md)* *[Lire le README dans d'autres langues.](./ALL_README.md)*
> *Ce package vous permet d’installer BookWyrm rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer BookWyrm 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.* > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
## Vue d’ensemble ## Vue d’ensemble
BookWyrm est un réseau social pour garder la trace de vos lectures, parler de livres, écrire des critiques et découvrir quoi lire ensuite. BookWyrm est un réseau social pour garder la trace de vos lectures, parler de livres, écrire des critiques et découvrir quoi lire ensuite.
**Version incluse :** 0.7.2~ynh1 **Version incluse :** 0.7.2~ynh1
**Démo :** https://joinbookwyrm.com/fr/ **Démo :** <https://joinbookwyrm.com/fr/>
## Captures d’écran ## Captures d’écran
![Capture d’écran de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg) ![Capture d’écran de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: Anti-fonctionnalités
- **Application sous licence libre restreinte **: L'application packagée est sous une licence globalement libre, mais avec des clauses qui pourraient restreindre son utilisation.
## Documentations et ressources ## Documentations et ressources
* Site officiel de l’app : <https://joinbookwyrm.com/fr/> - Site officiel de l’app : <https://joinbookwyrm.com/fr/>
* Documentation officielle de l’admin : <https://docs.joinbookwyrm.com/> - Documentation officielle de l’admin : <https://docs.joinbookwyrm.com/>
* Dépôt de code officiel de l’app : <https://github.com/bookwyrm-social/bookwyrm> - Dépôt de code officiel de l’app : <https://github.com/bookwyrm-social/bookwyrm>
* YunoHost Store: <https://apps.yunohost.org/app/bookwyrm> - YunoHost Store : <https://apps.yunohost.org/app/bookwyrm>
* Signaler un bug : <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing). Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/bookwyrm_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/bookwyrm_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
@ -47,4 +51,4 @@ ou
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
``` ```
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

54
README_gl.md Normal file
View file

@ -0,0 +1,54 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# BookWyrm para YunoHost
[![Nivel de integración](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
[![Instalar BookWyrm con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[Le este README en outros idiomas.](./ALL_README.md)*
> *Este paquete permíteche instalar BookWyrm 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
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
**Versión proporcionada:** 0.7.2~ynh1
**Demo:** <https://joinbookwyrm.com/fr/>
## Capturas de pantalla
![Captura de pantalla de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: Debes considerar
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
## Documentación e recursos
- Web oficial da app: <https://joinbookwyrm.com/fr/>
- Documentación oficial para admin: <https://docs.joinbookwyrm.com/>
- Repositorio de orixe do código: <https://github.com/bookwyrm-social/bookwyrm>
- Tenda YunoHost: <https://apps.yunohost.org/app/bookwyrm>
- Informar dun problema: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Info de desenvolvemento
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing).
Para probar a rama `testing`, procede deste xeito:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
ou
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
```
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>

54
README_zh_Hans.md Normal file
View file

@ -0,0 +1,54 @@
<!--
注意：此 README 由 <https://github.com/YunoHost/apps/tree/master/tools/readme_generator> 自动生成
请勿手动编辑。
-->
# YunoHost 上的 BookWyrm
[![集成程度](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![工作状态](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
[![使用 YunoHost 安装 BookWyrm](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bookwyrm)
*[阅读此 README 的其它语言版本。](./ALL_README.md)*
> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 BookWyrm。*
> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。*
## 概况
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
**分发版本：** 0.7.2~ynh1
**演示：** <https://joinbookwyrm.com/fr/>
## 截图
![BookWyrm 的截图](./doc/screenshots/screenshot-bookwyrm.jpg)
## :red_circle: 负面特征
- **Not totally free upstream**: The packaged app is under an overall free license, but with clauses that may restrict its use.
## 文档与资源
- 官方应用网站： <https://joinbookwyrm.com/fr/>
- 官方管理文档： <https://docs.joinbookwyrm.com/>
- 上游应用代码库： <https://github.com/bookwyrm-social/bookwyrm>
- YunoHost 商店： <https://apps.yunohost.org/app/bookwyrm>
- 报告 bug： <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## 开发者信息
请向 [`testing` 分支](https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing) 发送拉取请求。
如要尝试 `testing` 分支，请这样操作：
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
或
sudo yunohost app upgrade bookwyrm -u https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
```
**有关应用打包的更多信息：** <https://yunohost.org/packaging_apps>