From b527a4cd946a93e16528a324dfb784be1823d9ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sat, 20 Mar 2021 19:57:20 +0100 Subject: [PATCH] Small fixes (#2) * Small fixes * Clarify location of config file Co-authored-by: Jules Bertholet --- README.md | 16 ++++++---------- README_fr.md | 16 ++++++---------- issue_template.md | 2 +- 3 files changed, 13 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index c3a49a4..3eacd7d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Nitter for YunoHost [![Integration level](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg) -[![Install nitter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter) +[![Install Nitter with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install nitter quickly and simply on a YunoHost server. +> *This package allows you to install Nitter 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 @@ -13,7 +13,7 @@ Nitter is an alternative front-end for Twitter that is faster than the official This app requires a dedicated root domain. **ARM installations are NOT SUPPORTED.** -**Shipped version:** 52a0b530cc35c4a8ab28b58994d8c07322a58a51 +**Shipped version:** 2021.02.16 ## Screenshots ![](https://raw.githubusercontent.com/zedeus/nitter/master/screenshot.png) @@ -24,7 +24,7 @@ This app requires a dedicated root domain. **ARM installations are NOT SUPPORTED ## Configuration -The app's config file is stored in `/opt/yunohost/__APPNAME__/nitter.conf`. +The app's config file is stored in `/opt/yunohost/nitter/nitter.conf` (for the first instance, subsequent installs will go in `nitter__2`, `nitter__3`, etc). Users can override the defaults and set custom settings at `https://instance-domain.tld/settings`. ## Documentation @@ -33,8 +33,8 @@ Users can override the defaults and set custom settings at `https://instance-dom #### Multi-user support -Are LDAP and HTTP auth supported? **No** -Can the app be used by multiple users? **Yes** + * Are LDAP and HTTP auth supported? **No** + * Can the app be used by multiple users? **Yes** #### Supported architectures @@ -45,9 +45,6 @@ Can the app be used by multiple users? **Yes** * ARM installations are not supported and will not work -**More info on the documentation page:** -https://yunohost.org/packaging_apps - ## Links * Report a bug: https://github.com/YunoHost-Apps/nitter_ynh/issues @@ -59,7 +56,6 @@ https://yunohost.org/packaging_apps ## 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/nitter_ynh/tree/testing). To try the testing branch, please proceed like that. diff --git a/README_fr.md b/README_fr.md index b7f3dd1..dc6751f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,11 +1,11 @@ # Nitter pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/nitter.svg)](https://dash.yunohost.org/appci/app/nitter) ![](https://ci-apps.yunohost.org/ci/badges/nitter.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nitter.maintain.svg) -[![Installer nitter avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter) +[![Installer Nitter avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nitter) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer nitter rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer Nitter 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.* ## Vue d'ensemble @@ -13,7 +13,7 @@ Nitter est une interface alternative pour Twitter qui est plus rapide que le sit Cette application nécéssite un domaine dedié. **L'installation sur ARM n'est PAS PRISE EN CHARGE.** -**Version incluse :** 52a0b530cc35c4a8ab28b58994d8c07322a58a51 +**Version incluse :** 2021.02.16 ## Captures d'écran @@ -25,7 +25,7 @@ Cette application nécéssite un domaine dedié. **L'installation sur ARM n'est ## Configuration -Le ficher de configuration de l'appli se trouve à `/opt/yunohost/__APPNAME__/nitter.conf`. +Le ficher de configuration de l'appli se trouve à `/opt/yunohost/nitter/nitter.conf` (pour la première installation, les prochaines installations iront dans `nitter__2`, `nitter__3`, etc). Les utilisateurs peuvent modifier les paramétres par défaut en visitant`https://instance-domain.tld/settings`. ## Documentation @@ -45,21 +45,17 @@ Les utilisateurs peuvent modifier les paramétres par défaut en visitant`https: * Les installations sur ARM ne sont pas prises en charge et ne marcheront pas. -**Plus d'informations sur la page de documentation :** -https://yunohost.org/packaging_apps - ## Liens * Signaler un bug : https://github.com/YunoHost-Apps/nitter_ynh/issues - * Site de l'application : Lien vers le site officiel de cette application. - * Dépôt de l'application principale : Lien vers le dépôt officiel de l'application principale. + * Site de l'application : https://github.com/zedeus/nitter + * Dépôt de l'application principale : https://github.com/zedeus/nitter * Site web YunoHost : https://yunohost.org/ --- ## 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/nitter_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. diff --git a/issue_template.md b/issue_template.md index 85d8085..1a41579 100644 --- a/issue_template.md +++ b/issue_template.md @@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide 1. *Read this whole template first.* 2. *Determine if you are on the right place:* - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - - *Otherwise, the issue may be due to nitter itself. Refer to its documentation or repository for help.* + - *Otherwise, the issue may be due to Nitter itself. Refer to its documentation or repository for help.* - *When in doubt, post here and we will figure it out together.* 3. *Delete the italic comments as you write over them below, and remove this guide.* ---