Auto-update README

tomdereub · Jul 13, 2022 · 90c68e8 · 90c68e8
1 parent 88b821f
commit 90c68e8
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ It shall NOT be edited by hand.
 
 # OnlyOffice for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Working status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)  
 [![Install OnlyOffice with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=onlyoffice)
 
 *[Lire ce readme en français.](./README_fr.md)*
@@ -15,16 +15,28 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-Create and edit documents collaboratively
+OnlyOffice Document Server is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time.
+
+Online collaborative edition of OnlyOffice documents requires: 
+1. a server part, with two installation options:
+   1. OnlyOffice Document Server packaged for YunoHost. 
+   2. The [Community Document Server for Nextcloud](https://apps.nextcloud.com/apps/documentserver_community) 
+
+2. a client part, such as: 
+   1. The [ONLYOFFICE connector for Nextcloud](https://apps.nextcloud.com/apps/onlyoffice) 
+   2. The [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx)
+
+The Nextcloud addicts may follow [this tutorial](https://github.com/YunoHost-Apps/nextcloud_ynh#configure-onlyoffice-integration) to install (1.ii) and (2.i) on one Nextcloud instance. However, performance and architecture are limited.
+
 
 **Shipped version:** 7.1.0~ynh1
 
 **Demo:** https://www.onlyoffice.com/fr/download-desktop.aspx
 
 ## Screenshots
 
-![](./doc/screenshots/.DS_Store)
-![](./doc/screenshots/document-short.png)
+![Screenshot of OnlyOffice](./doc/screenshots/.DS_Store)
+![Screenshot of OnlyOffice](./doc/screenshots/document-short.png)
 
 ## Disclaimers / important information
 
@@ -78,20 +90,21 @@ Prerequisite: **OnlyOffice should be public**, see previous section.
 
 ## Documentation and resources
 
-* Official app website: https://www.onlyoffice.com
-* Upstream app code repository: https://github.com/ONLYOFFICE/DocumentServer
-* YunoHost documentation for this app: https://yunohost.org/app_onlyoffice
-* Report a bug: https://github.com/YunoHost-Apps/onlyoffice_ynh/issues
+* Official app website: <https://www.onlyoffice.com>
+* Upstream app code repository: <https://github.com/ONLYOFFICE/DocumentServer>
+* YunoHost documentation for this app: <https://yunohost.org/app_onlyoffice>
+* Report a bug: <https://github.com/YunoHost-Apps/onlyoffice_ynh/issues>
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade onlyoffice -u https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug
 ```
 
-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
diff --git a/README_fr.md b/README_fr.md
@@ -1,26 +1,42 @@
+<!--
+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.
+-->
+
 # OnlyOffice pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/onlyoffice.svg)](https://dash.yunohost.org/appci/app/onlyoffice) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/onlyoffice.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/onlyoffice.maintain.svg)  
 [![Installer OnlyOffice avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=onlyoffice)
 
 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer OnlyOffice 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
 
-Créez et éditer des documents collaborativement
+OnlyOffice Document Server est une suite bureautique en ligne comprenant des visualiseurs et des éditeurs de textes, feuilles de calcul et présentations, entièrement compatible avec les formats Office Open XML: .docx, .xlsx, .pptx et permettant l'édition collaborative en temps réel.
+
+L'édition collaborative en ligne des documents OnlyOffice nécessite :
+1. une partie serveur, avec deux options d'installation :
+    1. OnlyOffice Document Server packagé pour YunoHost.
+    2. Le [Community Document Server pour Nextcloud](https://apps.nextcloud.com/apps/documentserver_community).
+
+2. une partie client, telle que :
+    1. [ONLYOFFICE connector pour Nextcloud](https://apps.nextcloud.com/apps/onlyoffice)
+    2. [ONLYOFFICE Desktop Editors](https://www.onlyoffice.com/fr/download-desktop.aspx)
+
+Les utilisateurs de Nextcloud peuvent suivre [ce tutoriel](https://github.com/YunoHost-Apps/nextcloud_ynh/blob/testing/README_fr.md#configurer-lint%C3%A9gration-donlyoffice) pour installer le Community Document Server (1.ii) et ONLYOFFICE connector (2.i) sur une instance Nextcloud. Cependant, les performances et l'architecture sont limitées.
+
 
 **Version incluse :** 7.1.0~ynh1
 
 **Démo :** https://www.onlyoffice.com/fr/download-desktop.aspx
 
 ## Captures d'écran
 
-![](./doc/screenshots/.DS_Store)
-![](./doc/screenshots/document-short.png)
+![Capture d'écran de OnlyOffice](./doc/screenshots/.DS_Store)
+![Capture d'écran de OnlyOffice](./doc/screenshots/document-short.png)
 
 ## Avertissements / informations importantes
 
@@ -74,20 +90,21 @@ Prérequis : **OnlyOffice doit être public**, voir la section précédente.
 
 ## Documentations et ressources
 
-* Site officiel de l'app : https://www.onlyoffice.com
-* Dépôt de code officiel de l'app : https://github.com/ONLYOFFICE/DocumentServer
-* Documentation YunoHost pour cette app : https://yunohost.org/app_onlyoffice
-* Signaler un bug : https://github.com/YunoHost-Apps/onlyoffice_ynh/issues
+* Site officiel de l'app : <https://www.onlyoffice.com>
+* Dépôt de code officiel de l'app : <https://github.com/ONLYOFFICE/DocumentServer>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_onlyoffice>
+* Signaler un bug : <https://github.com/YunoHost-Apps/onlyoffice_ynh/issues>
 
 ## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/onlyoffice_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade onlyoffice -u https://github.com/YunoHost-Apps/onlyoffice_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>