diff --git a/README.md b/README.md index e195937..f4ffe3e 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,51 @@ + + # Grammalecte server for YunoHost -[![Integration level](https://dash.yunohost.org/integration/grammalecte.svg)](https://dash.yunohost.org/appci/app/grammalecte) ![](https://ci-apps.yunohost.org/ci/badges/grammalecte.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grammalecte.maintain.svg) -[![Install grammalecte with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grammalecte) +[![Integration level](https://dash.yunohost.org/integration/grammalecte.svg)](https://dash.yunohost.org/appci/app/grammalecte) ![Working status](https://ci-apps.yunohost.org/ci/badges/grammalecte.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/grammalecte.maintain.svg) +[![Install Grammalecte server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grammalecte) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Grammalecte quickly and simply on a YunoHost server. +> *This package allows you to install Grammalecte 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 -Grammalecte is a spelling, grammar and typography checking service that supports French and Occitan. This package installs the server version, that provides an API for use by other programs (like LanguageTool). -**Shipped version:** 2.1.1 +Grammar and typography checker for French and Occitan (API) + +**Shipped version:** 2.1.1~ynh2 ## Screenshots -![](https://grammalecte.net/grammalecte/img/screenshots/lo-correcteur1.png) +![Screenshot of Grammalecte server](./doc/screenshots/screenshot.png) -![](https://grammalecte.net/grammalecte/img/screenshots/lo-correcteur2.png) +## Disclaimers / important information ## Configuration The Grammalecte server can be configured by changing the command-line options of the `systemd` service `grammalecte.service`. -## Documentation +## Documentation and resources - * Official documentation: https://grammalecte.net/ - -#### Multi-user support - -N/A - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/grammalecte.svg)](https://ci-apps.yunohost.org/ci/apps/grammalecte/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/grammalecte.svg)](https://ci-apps-arm.yunohost.org/ci/apps/grammalecte/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/grammalecte_ynh/issues - * App website: https://grammalecte.net/ - * Upstream app repository: http://code.grammalecte.net:8080/ - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* 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/grammalecte_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug or sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index ed8cde1..f7d2776 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,58 +1,51 @@ -# Serveur Grammalecte pour YunoHost + -[![Niveau d'intégration](https://dash.yunohost.org/integration/grammalecte.svg)](https://dash.yunohost.org/appci/app/grammalecte) ![](https://ci-apps.yunohost.org/ci/badges/grammalecte.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grammalecte.maintain.svg) -[![Installer grammalecte avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grammalecte) +# Grammalecte server pour YunoHost -*[Read this readme in english.](./README.md)* +[![Niveau d'intégration](https://dash.yunohost.org/integration/grammalecte.svg)](https://dash.yunohost.org/appci/app/grammalecte) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/grammalecte.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/grammalecte.maintain.svg) +[![Installer Grammalecte server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grammalecte) -> *Ce package vous permet d'installer Grammalecte 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 Grammalecte 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 -Grammalecte est un correctuer ortographique, grammatical, et typographique pour le Français et l'Occitan. Ce paquet installe la version serveur, qui fournit une API que d'autres programmes (comme LanguageTool par exemple) peuvent utilizer. -**Version incluse :** 2.1.1 +Correcteur grammatical et typographique pour le Français et l'Occitan (API) + +**Version incluse :** 2.1.1~ynh2 ## Captures d'écran -![](https://grammalecte.net/grammalecte/img/screenshots/lo-correcteur1.png) +![Capture d'écran de Grammalecte server](./doc/screenshots/screenshot.png) -![](https://grammalecte.net/grammalecte/img/screenshots/lo-correcteur2.png) +## Avertissements / informations importantes ## Configuration -Le serveur Grammalecte peut etre configuré en changeant les options de ligne command du service `systemd` `grammalecte.service`. +The Grammalecte server can be configured by changing the command-line options of the `systemd` service `grammalecte.service`. -## Documentation +## Documentations et ressources - * Documentation officielle : https://grammalecte.net/ - -#### Support multi-utilisateur - -S/O - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/grammalecte.svg)](https://ci-apps.yunohost.org/ci/apps/grammalecte/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/grammalecte.svg)](https://ci-apps-arm.yunohost.org/ci/apps/grammalecte/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/grammalecte_ynh/issues - * Site de l'application : https://grammalecte.net/ - * Dépôt de l'application principale : http://code.grammalecte.net:8080/ - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* 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/grammalecte_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug ou sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** diff --git a/check_process b/check_process index 17c6e88..a27ed88 100644 --- a/check_process +++ b/check_process @@ -5,7 +5,7 @@ ;; Test complet ; Manifest - domain="domain.tld" (DOMAIN) + domain="domain.tld" ; Checks pkg_linter=1 setup_sub_dir=0 diff --git a/conf/app.src b/conf/app.src index fe4ba2d..a43fa00 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,4 +1,4 @@ -SOURCE_URL=https://grammalecte.net/grammalecte/zip/Grammalecte-fr-v2.1.1.zip +SOURCE_URL=https://grammalecte.net/zip/Grammalecte-fr-v2.1.1.zip SOURCE_SUM=f643eca603652469947d9bd85fb0ec08f8eb0f7b6ab925d2fb18bfc6fdd8d21c SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..e69de29 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..8bbac53 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,3 @@ +## Configuration + +The Grammalecte server can be configured by changing the command-line options of the `systemd` service `grammalecte.service`. diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..97cc446 Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/manifest.json b/manifest.json index a564363..d13def9 100644 --- a/manifest.json +++ b/manifest.json @@ -6,15 +6,20 @@ "en": "Grammar and typography checker for French and Occitan (API)", "fr": "Correcteur grammatical et typographique pour le Français et l'Occitan (API)" }, - "version": "2.1.1~ynh1", + "version": "2.1.1~ynh2", "url": "https://grammalecte.net", + "upstream": { + "license": "GPL-3.0-only", + "website": "https://grammalecte.net", + "code": "http://code.grammalecte.net:8080/" + }, "license": "GPL-3.0-only", "maintainer": { "name": "Jules Bertholet", "email": "jules.bertholet@gmail.com" }, "requirements": { - "yunohost": ">= 4.1.3" + "yunohost": ">= 11.0.9" }, "multi_instance": true, "services": [ @@ -24,8 +29,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "example.com" + "type": "domain" } ] }