소스 검색

Auto-update README

yunohost-bot 3 년 전
부모
커밋
ff41d942fb
2개의 변경된 파일49개의 추가작업 그리고 74개의 파일을 삭제
  1. 24 35
      README.md
  2. 25 39
      README_fr.md

+ 24 - 35
README.md

@@ -1,70 +1,59 @@
+<!--
+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.
+-->
+
 # Archivist for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/archivist.svg)](https://dash.yunohost.org/appci/app/archivist) ![](https://ci-apps.yunohost.org/ci/badges/archivist.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/archivist.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-)  
-[![Install archivist with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=archivist)
+[![Integration level](https://dash.yunohost.org/integration/archivist.svg)](https://dash.yunohost.org/appci/app/archivist) ![Working status](https://ci-apps.yunohost.org/ci/badges/archivist.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/archivist.maintain.svg)  
+[![Install Archivist with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=archivist)
 
 *[Lire ce readme en français.](./README_fr.md)*
 
-> *This package allow you to install archivist quickly and simply on a YunoHost server.  
-If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
+> *This package allows you to install Archivist 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
+
 Archivist is an automatic backup system for your server.  
 It able to makes backups of your YunoHost core and your apps by using the YunoHost backup command.  
 It can also makes backups of specified directories.  
 Your backups can be send to many other places, local or distant.  
 Archivist is automatically launched periodicaly to update your backups and send the modifications to the other places.
 
-**Shipped version:** 1.3.2
 
-## Screenshots
 
-## Demo
-
-No demo available.
+**Shipped version:** 1.3.2~ynh2
+## Disclaimers / important information
 
 ## Configuration
 
 The configuration of archivist can be changed in the file /opt/yunohost/archivist/Backup_list.conf  
 Please read the [documentation](https://github.com/maniackcrudelis/archivist/blob/master/Configuration.md) about the configuration of archivist for more informations.
 
-## Documentation
-
- * YunoHost documentation: There no specific documentations, feel free to contribute.
-
-## YunoHost specific features
-
-#### Multi-users support
-
-Not relevant.
-
-#### Supported architectures
-
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/archivist%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/archivist/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/archivist%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/archivist/)
-* Buster x86-64b - [![Build Status](https://ci-buster.nohost.me/ci/logs/archivist%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/archivist/)
-
 ## Limitations
 
 * Encfs, which be used to encrypt the data, is not fully secured.  
 Have a look to the [security audit](https://defuse.ca/audits/encfs.htm) to have more informations.
 
-## Links
 
- * Report a bug: https://github.com/YunoHost-Apps/archivist_ynh/issues
- * archivist website: https://github.com/maniackcrudelis/archivist
- * YunoHost website: https://yunohost.org/
+## Documentation and resources
 
----
+* Official app website: <https://github.com/maniackcrudelis/archivist>
+* Upstream app code repository: <https://github.com/maniackcrudelis/archivist>
+* YunoHost documentation for this app: <https://yunohost.org/app_archivist>
+* Report a bug: <https://github.com/YunoHost-Apps/archivist_ynh/issues>
 
-Developers infos
-----------------
+## Developer info
 
-Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --force --debug
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade archivist -u https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
 ```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

+ 25 - 39
README_fr.md

@@ -1,72 +1,58 @@
+<!--
+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.
+-->
+
 # Archivist pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/archivist.svg)](https://dash.yunohost.org/appci/app/archivist) ![](https://ci-apps.yunohost.org/ci/badges/archivist.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/archivist.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-)  
-[![Installer archivist avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=archivist)
+[![Niveau d'intégration](https://dash.yunohost.org/integration/archivist.svg)](https://dash.yunohost.org/appci/app/archivist) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/archivist.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/archivist.maintain.svg)  
+[![Installer Archivist avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=archivist)
 
 *[Read this readme in english.](./README.md)*
 
-> *Ce package vous permet d'installer archivist rapidement et simplement sur un serveur YunoHost.  
-Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.*
+> *Ce package vous permet d'installer Archivist 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
 
-## Résumé
 Archivist est un système de sauvegarde automatique pour votre serveur.  
 Il est capable de faire des sauvegardes de votre noyau YunoHost et de vos applications en utilisant la commande de backup de YunoHost.  
 Il peut également faire des sauvegardes de répertoires spécifiques.  
 Vos sauvegardes peuvent être envoyées à de nombreux autres endroits, locaux ou distants.  
 Archivist est automatiquement lancé périodiquement pour mettre à jour vos sauvegardes et envoyer les modifications aux autres emplacements.
 
-**Version embarquée:** 1.3.2
-
-## Captures d'écran
-
-## Démo
 
-Aucune démo pour cette application.
+**Version incluse :** 1.3.2~ynh2
+## Avertissements / informations importantes
 
 ## Configuration
 
 La configuration d'archivist peut être modifiée dans le fichier /opt/yunohost/archivist/Backup_list.conf  
 Veuillez lire la [documentation](https://github.com/maniackcrudelis/archivist/blob/master/Configuration_fr.md) sur la configuration d'archivist pour plus d'informations.
 
-## Documentation
-
- * Documentation YunoHost: Il n'y a pas d'autre documentation, n'hésitez pas à contribuer.
-
-## Fonctionnalités spécifiques à YunoHost
-
-#### Support multi-utilisateurs
-
-Non applicable
-
-#### Architectures supportées.
-
-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/archivist%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/archivist/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/archivist%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/archivist/)
-* Buster x86-64b - [![Build Status](https://ci-buster.nohost.me/ci/logs/archivist%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/archivist/)
-
 ## Limitations
 
 * Encfs, qui est utilisé pour chiffrer les données, n'est pas parfaitement sécurisé.  
 Consultez l'[audit de sécurité](https://defuse.ca/audits/encfs.htm) pour avoir plus d'informations.
 
-## Informations additionnelles
-
-## Liens
 
- * Reporter un bug: https://github.com/YunoHost-Apps/archivist_ynh/issues
- * Site de archivist: https://github.com/maniackcrudelis/archivist
- * Site de YunoHost: https://yunohost.org/
+## Documentations et ressources
 
----
+* Site officiel de l'app : <https://github.com/maniackcrudelis/archivist>
+* Dépôt de code officiel de l'app : <https://github.com/maniackcrudelis/archivist>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_archivist>
+* Signaler un bug : <https://github.com/YunoHost-Apps/archivist_ynh/issues>
 
-Informations à l'intention des développeurs
-----------------
+## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/archivist_ynh/tree/testing).
 
-Pour tester la branche testing, merci de procéder ainsi.
-```
-sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --force --debug
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade archivist -u https://github.com/YunoHost-Apps/archivist_ynh/tree/testing --debug
 ```
+
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>