mirror of
https://github.com/YunoHost-Apps/fittrackee_ynh.git
synced 2024-09-03 18:36:16 +02:00
Auto-update README
This commit is contained in:
parent
2bc59cb9b5
commit
5dfde1ea43
2 changed files with 18 additions and 16 deletions
21
README.md
21
README.md
|
@ -6,7 +6,7 @@ It shall NOT be edited by hand.
|
||||||
# BookWyrm for YunoHost
|
# BookWyrm for YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Working status](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Working status](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
|
||||||
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=BookWyrm_ynh)
|
[![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)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
@ -15,38 +15,39 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next. Federation allows BookWyrm users to join small, trusted communities that can connect with one another, and with other ActivityPub services like Mastodon and Pleroma.
|
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
|
||||||
|
|
||||||
|
|
||||||
**Shipped version:** 0.5.3~ynh1
|
**Shipped version:** 0.5.3~ynh1
|
||||||
|
|
||||||
**Demo:** https://joinbookwyrm.com/
|
**Demo:** https://joinbookwyrm.com/fr/
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![Screenshot of Example app](./doc/screenshots/screenshot-bookwyrm.jpg)
|
![Screenshot of BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
|
||||||
|
|
||||||
## Disclaimers / important information
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
This project is still young and isn't, at the moment, very stable, so please proceed with caution when running in production.
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: <https://joinbookwyrm.com/>
|
* 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 documentation for this app: <https://yunohost.org/app_bookwyrm>
|
* YunoHost documentation for this app: <https://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
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade example -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
|
||||||
```
|
```
|
||||||
|
|
||||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
|
|
13
README_fr.md
13
README_fr.md
|
@ -6,16 +6,16 @@ It shall NOT be edited by hand.
|
||||||
# BookWyrm pour YunoHost
|
# BookWyrm pour YunoHost
|
||||||
|
|
||||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/bookwyrm.svg)](https://dash.yunohost.org/appci/app/bookwyrm) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/bookwyrm.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/bookwyrm.maintain.svg)
|
||||||
[![Installer bookwyrm app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=BookWyrm_ynh)
|
[![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)*
|
*[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 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, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## Vue d'ensemble
|
||||||
|
|
||||||
BookWyrm est un réseau social qui vous permet de suivre vos lectures, de parler de livres, d'écrire des critiques et de découvrir vos prochaines lectures. Federation permet aux utilisateurs de BookWyrm de rejoindre de petites communautés de confiance qui peuvent se connecter entre elles et avec d'autres services ActivityPub comme Mastodon et Pleroma.
|
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.5.3~ynh1
|
**Version incluse :** 0.5.3~ynh1
|
||||||
|
@ -24,17 +24,18 @@ BookWyrm est un réseau social qui vous permet de suivre vos lectures, de parler
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||
![Capture d'écran de Example app](./doc/screenshots/screenshot-bookwyrm.jpg)
|
![Capture d'écran de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
Ce projet est encore jeune et n'est pas, pour le moment, très stable, faites preuve de prudence lors de son utilisation en production.
|
||||||
|
|
||||||
## 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>
|
||||||
* Documentation YunoHost pour cette app : <https://yunohost.org/bookwyrm_example>
|
* Documentation YunoHost pour cette app : <https://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
|
||||||
|
@ -46,7 +47,7 @@ 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
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade example -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>
|
||||||
|
|
Loading…
Reference in a new issue