YunoHost-Apps/fittrackee_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/fittrackee_ynh.git synced 2024-09-03 18:36:16 +02:00
Code Issues Activity Actions

fix README

Browse source
This commit is contained in:
Thomas 2023-03-06 13:25:09 +01:00 • committed by GitHub
parent 04b6cdf602
commit e0fc4d229a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 0 additions and 124 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
README.md
View file

@ -1,62 +0,0 @@
<!--
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.
-->
# FitTrackee for YunoHost
[![Integration level](https://dash.yunohost.org/integration/fittrackee.svg)](https://dash.yunohost.org/appci/app/fittrackee) ![Working status](https://ci-apps.yunohost.org/ci/badges/fittrackee.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/fittrackee.maintain.svg)
[![Install FitTrackee with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=fitrtrackee)
*[Lire ce readme en français.](./README_fr.md)*
> *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.*
## Overview
BookWyrm is a social network for tracking your reading, talking about books, writing reviews, and discovering what to read next.
**Shipped version:** 0.5.4~ynh1
**Demo:** https://joinbookwyrm.com/fr/
## Screenshots
![Screenshot of Fittrackee](./doc/screenshots/screenshot-fittrackee.png)
## 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.
Generate the admin code with ``` sudo -u bookwyrm /var/www/bookwyrm/venv/bin/python3 /var/www/bookwyrm/manage.py admin_code```, and copy the admin code to use when you create your admin account. You can get your code at any time by re-running that command. Here's an example output:
``` bash
*******************************************
Use this code to create your admin account:
c6c35779-af3a-4091-b330-c026610920d6
*******************************************
```
## Documentation and resources
* Official app website: <https://joinbookwyrm.com/fr/>
* Official admin documentation: <https://docs.joinbookwyrm.com/>
* Upstream app code repository: <https://github.com/bookwyrm-social/bookwyrm>
* YunoHost documentation for this app: <https://yunohost.org/app_bookwyrm>
* Report a bug: <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Developer info
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.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/bookwyrm_ynh/tree/testing --debug
or
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>

62
README_fr.md
View file

@ -1,62 +0,0 @@
<!--
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.
-->
# 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)
[![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)*
> *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.*
## 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.
**Version incluse :** 0.5.4~ynh1
**Démo :** https://joinbookwyrm.com/fr/
## Captures d’écran
![Capture d’écran de BookWyrm](./doc/screenshots/screenshot-bookwyrm.jpg)
## 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.
Générez le code administrateur avec ``` sudo -u bookwyrm /var/www/bookwyrm/venv/bin/python3 /var/www/bookwyrm/manage.py admin_code```, et copiez le code administrateur à utiliser lors de la création de votre compte administrateur. Vous pouvez obtenir votre code à tout moment en réexécutant cette commande. Voici un exemple de sortie :
```bash
*******************************************
Use this code to create your admin account:
c6c35779-af3a-4091-b330-c026610920d6
*******************************************
```
## Documentations et ressources
* Site officiel de l’app : <https://joinbookwyrm.com/fr/>
* Documentation officielle de l’admin : <https://docs.joinbookwyrm.com/>
* Dépôt de code officiel de l’app : <https://github.com/bookwyrm-social/bookwyrm>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_bookwyrm>
* Signaler un bug : <https://github.com/YunoHost-Apps/bookwyrm_ynh/issues>
## Informations pour les développeurs
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.
``` 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
```
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>