diff --git a/README.md b/README.md index 9423af3..670fba4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ + + # Weblate for YunoHost [![Integration level](https://dash.yunohost.org/integration/weblate.svg)](https://dash.yunohost.org/appci/app/weblate) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/weblate.maintain.svg) [![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=weblate) -> *This package allows you to install Weblate quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Weblate 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 -Weblate is a libre web-based translation tool with tight version control integration. It provides two user interfaces, propagation of translations across components, quality checks and automatic linking to source files. +Translation platform using Git and Python -**Shipped version:** 4.7 +**Shipped version:** 4.7~ynh1 + +**Demo:** https://translate.yunohost.org ## Screenshots -![](https://weblate.org/static/img/BigScreenshot.png) +![](./doc/screenshots/BigScreenshot.png) -## Demo - -* [YunoHost project uses Weblate for translations](https://translate.yunohost.org) +## Disclaimers / important information ## GitHub @@ -38,31 +45,16 @@ You can edit the file `$final_path/local_settings.py` to enable or disable featu It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), I'm unsure it is a good idea to connect this kind of tools to your LDAP. -#### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/weblate/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/weblate%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/weblate/) +* Official app website: https://weblate.org +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://docs.weblate.org/ +* Upstream app code repository: https://github.com/WeblateOrg/weblate +* YunoHost documentation for this app: https://yunohost.org/app_weblate +* Report a bug: https://github.com/YunoHost-Apps/weblate_ynh/issues -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug about this package: https://github.com/YunoHost-Apps/weblate_ynh - * Report a bug about Weblate itself: https://github.com/WeblateOrg/weblate - * Documentation: https://docs.weblate.org/ - * Weblate website: https://weblate.org/ - * YunoHost website: https://yunohost.org/ - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing). @@ -72,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/test or sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..087c86c --- /dev/null +++ b/README_fr.md @@ -0,0 +1,63 @@ +# Weblate pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/weblate.svg)](https://dash.yunohost.org/appci/app/weblate) ![](https://ci-apps.yunohost.org/ci/badges/weblate.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/weblate.maintain.svg) +[![Installer Weblate avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=weblate) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Weblate 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 + +Plateforme de traduction utilisant Git et Python + +**Version incluse :** 4.7~ynh1 + +**Démo :** https://translate.yunohost.org + +## Captures d'écran + +![](./doc/screenshots/BigScreenshot.png) + +## Avertissements / informations importantes + +## GitHub + +Vous devrez donner à Weblate un utilisateur GitHub et un jeton. Veuillez lire [la documentation de GitHub sur le jeton](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). +Cet utilisateur ne sera utilisé que pour ouvrir la pull-request, chaque traduction garde son auteur. + +**Clés SSH**, vous devrez vous rendre dans l'administration, générer une clé publique pour Weblate et ajouter github.com pour que Weblate connaisse l'empreinte digitale. Veuillez noter que si votre compte possède déjà une clé publique (ssh-rsa), vous devrez ajouter manuellement celle de Weblate à votre compte GitHub. + +## Paramètres et mises à niveau + +Presque tout ce qui concerne la configuration de Weblate est géré dans un fichier `settings.py`. +Vous pouvez éditer le fichier `$final_path/local_settings.py` pour activer ou désactiver des fonctionnalités. + +# Divers + +## Connexion LDAP + +Cela ne fonctionne pas encore, mais bien que [cela semble faisable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), je ne suis pas sûr que ce soit le cas une bonne idée de connecter ce genre d'outils à votre LDAP. +## Documentations et ressources + +* Site officiel de l'app : https://weblate.org +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://docs.weblate.org/ +* Dépôt de code officiel de l'app : https://github.com/WeblateOrg/weblate +* Documentation YunoHost pour cette app : https://yunohost.org/app_weblate +* Signaler un bug : https://github.com/YunoHost-Apps/weblate_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug +ou +sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file