From 5a6802c5d41ad0ced63206b7317ee30ae9007d42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Fri, 19 Jun 2020 23:08:26 +0200 Subject: [PATCH] Update README.md --- README.md | 47 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5e95f42..ad5950b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ -[![Install Weblate with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=weblate) -![](https://dash.yunohost.org/integration/weblate.svg) -# Weblate translation platform for YunoHost +# 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.png)](https://install-app.yunohost.org/?app=weblate) + +> *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. The YunoHost team uses [Weblate](https://weblate.org) for translations: https://translate.yunohost.org +**Shipped version:** 3.8.0 + ## Admin account An admin user is created at installation, the login is what you provided at installation, the password is **weblate**. @@ -18,14 +26,14 @@ After upgrading: * Any per user permissions are removed, please assign users to appropriate groups and roles to grant them permissions. * Any custom groups will not have any permissions after upgrade, please grant the permissions again. -## Github +## GitHub -You'll need to give weblate a github user and a token. Please read [github's documentation about token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). +You'll need to give Weblate a GitHub user and a token. Please read [github's documentation about token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). This user will only be used to open the pull-request, each translation keep his author. -**Careful**, I still have to understand why, but you'll have to **manually** move your hub binary frile from /var/www/$app/bin/ to /usr/bin to enable pull request on github. I'm close to fix this. +**Careful**, I still have to understand why, but you'll have to **manually** move your hub binary frile from `/var/www/$app/bin/` to `/usr/bin` to enable pull request on GitHub. I'm close to fix this. -**SSH keys**, you'll have to go in administration, and generate a public key for weblate and add github.com so weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you'll have to manually add the weblate's one to your github account. +**SSH keys**, you'll have to go in administration, and generate a public key for Weblate and add github.com so Weblate knows the fingerprint. Please note if your account already have a public key (ssh-rsa), you'll have to manually add the Weblate's one to your GitHub account. ## Settings and upgrades @@ -34,10 +42,10 @@ You'll probably edit it to enable or disable diverse features, it is stored in ` Unfortunatly, this settings file also gets upgrades for each release. -This package will : +This package will: * generate a default settings file for your current installation, -* send you a diff with your actual settings (the content will be sent to *root*, and only basic information for weblate's admin), +* send you a diff with your actual settings (the content will be sent to *root*, and only basic information for Weblate's admin), * generate a default settings file the new weblate's version, that will **replace** your actual `settings.py`. You'll have to **manually** add your previous changes to this new `settings.py`. @@ -65,13 +73,18 @@ It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/lat * to be added: [ ] use jq instead of grep/sed [ ] change URL script -[ ] use debian package for lxml (may unlock ARM support) +[ ] use Debian package for lxml (may unlock ARM support) [ ] Add configuration options using the YunoHost interface (https://forum.yunohost.org/t/yunohost-3-1-minor-stable-release-version-stable-mineure/5445) -[ ] Add fail2ban script +[ ] Add Fail2ban script [ ] Enable CHECK_LIST? [ ] Enable AUTOFIX_LIST? [ ] Enable Translation Memory? +#### Supported architectures + +* 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/) + ## Links * Report a bug about this package: https://github.com/YunoHost-Apps/weblate_ynh @@ -79,3 +92,15 @@ It doesn't work yet, but while [it looks doable](https://docs.weblate.org/en/lat * Documentation: https://docs.weblate.org/ * Weblate website: https://weblate.org/ * YunoHost website: https://yunohost.org/ + + Developer info +---------------- + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/weblate_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug +or +sudo yunohost app upgrade weblate -u https://github.com/YunoHost-Apps/weblate_ynh/tree/testing --debug +```