mirror of
https://github.com/YunoHost-Apps/grammalecte_ynh.git
synced 2024-09-03 20:36:23 +02:00
Auto-update README
This commit is contained in:
parent
3035f6911d
commit
c806e5c448
2 changed files with 48 additions and 62 deletions
51
README.md
51
README.md
|
@ -1,58 +1,51 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# Grammalecte server for YunoHost
|
# Grammalecte server for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/grammalecte)  
|
[](https://dash.yunohost.org/appci/app/grammalecte)  
|
||||||
[](https://install-app.yunohost.org/?app=grammalecte)
|
[](https://install-app.yunohost.org/?app=grammalecte)
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[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.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## 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
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|
## Disclaimers / important information
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The Grammalecte server can be configured by changing the command-line options of the `systemd` service `grammalecte.service`.
|
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/
|
* Official app website: <https://grammalecte.net>
|
||||||
|
* Upstream app code repository: <http://code.grammalecte.net:8080/>
|
||||||
#### Multi-user support
|
* YunoHost documentation for this app: <https://yunohost.org/app_grammalecte>
|
||||||
|
* Report a bug: <https://github.com/YunoHost-Apps/grammalecte_ynh/issues>
|
||||||
N/A
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/grammalecte/)
|
|
||||||
* ARMv8-A - [](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/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## 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).
|
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.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
|
|
57
README_fr.md
57
README_fr.md
|
@ -1,58 +1,51 @@
|
||||||
# Serveur Grammalecte pour YunoHost
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/grammalecte)  
|
# Grammalecte server pour YunoHost
|
||||||
[](https://install-app.yunohost.org/?app=grammalecte)
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/grammalecte)  
|
||||||
|
[](https://install-app.yunohost.org/?app=grammalecte)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d'installer Grammalecte rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d'installer Grammalecte server 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.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## 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
|
## Captures d'écran
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|
## Avertissements / informations importantes
|
||||||
|
|
||||||
## Configuration
|
## 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/
|
* Site officiel de l'app : <https://grammalecte.net>
|
||||||
|
* Dépôt de code officiel de l'app : <http://code.grammalecte.net:8080/>
|
||||||
#### Support multi-utilisateur
|
* Documentation YunoHost pour cette app : <https://yunohost.org/app_grammalecte>
|
||||||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/grammalecte_ynh/issues>
|
||||||
S/O
|
|
||||||
|
|
||||||
#### Architectures supportées
|
|
||||||
|
|
||||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/grammalecte/)
|
|
||||||
* ARMv8-A - [](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/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## 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).
|
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.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
```
|
|
||||||
|
``` bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
sudo yunohost app upgrade grammalecte -u https://github.com/YunoHost-Apps/grammalecte_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
||||||
|
|
Loading…
Add table
Reference in a new issue