diff --git a/README.md b/README.md index 2ec440c..08b950e 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,56 @@ + + # LanguageTool server for YunoHost -[![Integration level](https://dash.yunohost.org/integration/languagetool.svg)](https://dash.yunohost.org/appci/app/languagetool) ![](https://ci-apps.yunohost.org/ci/badges/languagetool.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/languagetool.maintain.svg) -[![Install languagetool with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=languagetool) +[![Integration level](https://dash.yunohost.org/integration/languagetool.svg)](https://dash.yunohost.org/appci/app/languagetool) ![Working status](https://ci-apps.yunohost.org/ci/badges/languagetool.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/languagetool.maintain.svg) +[![Install LanguageTool server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=languagetool) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install LanguageTool quickly and simply on a YunoHost server. +> *This package allows you to install LanguageTool server 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 + LanguageTool is a multilingual grammar, style, and spell checker. This package provides the API server for use by other programs, like the LanguageTool extensions for browsers and word processors. -**Shipped version:** 5.7 + +**Shipped version:** 5.7~ynh2 + +**Demo:** https://api.languagetool.org/ ## Screenshots -![](https://github.com/YunoHost-Apps/languagetool_ynh/raw/master/screenshot.png) +![Screenshot of LanguageTool server](./doc/screenshots/screenshot_fr.png) +![Screenshot of LanguageTool server](./doc/screenshots/screenshot.png) -## Demo - -* [Official demo](https://api.languagetool.org/) +## Disclaimers / important information ## Configuration There is a configuration file at `/opt/yunohost/languagetool/languagetool.conf` (for the first install). -## Documentation - * Official documentation: https://dev.languagetool.org/ +## Documentation and resources -#### Multi-user support - -* Are LDAP and HTTP auth supported? **N/A** -* Can the app be used by multiple users? **N/A** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/languagetool%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/languagetool/) -* ARMv8-A - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/languagetool_ynh/issues - * App website: https://languagetool.org/ - * Upstream app repository: https://github.com/languagetool-org/languagetool - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug or sudo yunohost app upgrade languagetool -u https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index ee732ad..8bfd2eb 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,61 +1,56 @@ -# Serveur LanguageTool pour YunoHost + -[![Niveau d'intégration](https://dash.yunohost.org/integration/languagetool.svg)](https://dash.yunohost.org/appci/app/languagetool) ![](https://ci-apps.yunohost.org/ci/badges/languagetool.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/languagetool.maintain.svg) -[![Installer languagetool avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=languagetool) +# LanguageTool server pour YunoHost -*[Read this readme in english.](./README.md)* +[![Niveau d'intégration](https://dash.yunohost.org/integration/languagetool.svg)](https://dash.yunohost.org/appci/app/languagetool) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/languagetool.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/languagetool.maintain.svg) +[![Installer LanguageTool server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=languagetool) -> *Ce package vous permet d'installer LanguageTool rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer LanguageTool server 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 + LanguageTool est un correcteur d'orthographe, de grammaire et de style multilingue. Ce paquet fournit le serveur API pour utilisation depuis d'autres programmes, comme les extensions LangageTool pour navigateurs et logiciels de bureautique. -**Version incluse :** 5.7 + +**Version incluse :** 5.7~ynh2 + +**Démo :** https://api.languagetool.org/ ## Captures d'écran -![](https://github.com/YunoHost-Apps/languagetool_ynh/raw/master/screenshot_fr.png) +![Capture d'écran de LanguageTool server](./doc/screenshots/screenshot_fr.png) +![Capture d'écran de LanguageTool server](./doc/screenshots/screenshot.png) -## Démo - -* [Démo officielle](https://api.languagetool.org/) +## Avertissements / informations importantes ## Configuration Il y a un fichier de configuration à `/opt/yunohost/languagetool/languagetool.conf` (pour la première installation). -## Documentation +## Documentations et ressources - * Documentation officielle : https://dev.languagetool.org/ - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **S/O** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **S/O** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/languagetool%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/languagetool/) -* ARMv8-A - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/languagetool_ynh/issues - * Site de l'application : https://languagetool.org/fr/ - * Dépôt de l'application principale : https://github.com/languagetool-org/languagetool - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug ou sudo yunohost app upgrade languagetool -u https://github.com/YunoHost-Apps/languagetool_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :**