Update Readmes

This commit is contained in:
Arne 2024-09-10 08:35:42 +02:00
parent 7c4833d700
commit d981d5737b
3 changed files with 375 additions and 26 deletions

149
README-en.md Normal file
View file

@ -0,0 +1,149 @@
# Announcement:
## Monocles Messenger becomes monocles chat
What you can expect:
- Range of functions remains the same
- Support chat rooms are merged
- Colors and logos are adapted to monocles chat
- App is still available for free on codeberg and F-Droid Store
Your monocles Team
-----
# <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/src/main/ic_launcher-playstore.png" width="30"> monocles chat
🇩🇪… [Deutsche Version der Readme hier verfügbar.](README.md) / [Francais ici](README-fr.md)
monocles chat is a modern and secure Android XMPP client. Based on blabber.im and [Conversations](https://github.com/siacs/Conversations) but with a lot of changes and additional features.
The changes aim to improve usability and ease transition from pre-installed and other widespread chats. Here are some screenshots:
<img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/00.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/01.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/02.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/03.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/04.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/05.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/06.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/07.png" width="200" />
Screens designed by Pigeonalley (https://pigeonalley.com)
### Presettings
monocles chat has different presettings compared to blabber.im:
* don't show previews of weblinks in chat
* don't show previews of locations in chat
* don't automatically download all attachments
### OTR
monocles chat supports OTR encryption! Though it's not easy to use OTR does have some advantages:
<a href="https://en.wikipedia.org/wiki/Off-the-Record_Messaging#Implementation">https://en.wikipedia.org/wiki/Off-the-Record_Messaging#Implementation</a>
## Download
monocles chat is available for install in the F-Droid
Alternatively beta-release APKs are available via codeberg: [Releases](https://codeberg.org/Arne/monocles_chat/releases)
#### monocles chat nightly and beta
nightly or beta-release APKs are available via codeberg: [Releases](https://codeberg.org/Arne/monocles_chat/releases)
## Social Media
Follow us on <a rel="me" href="https://monocles.social/@monocles">monocles social</a>
There are also English and German speaking XMPP-room focusing on support and development of the monocles chat.
If you are interested in the development of the chat, here is a MUC for you (English and German speaking):
Development-Chat: [development@conference.monocles.de](https://monocles.chat/)
There also is an Support-MUC where you can ask questions and get help with issues you may encounter, see further below for details.
## How can I support translations ?
You can create merge request and add new languages as locales and add and edit translations already existing.
## Help! I've encountered issues!
The easiest way to get some help is to join our support-MUC (both English and German).
Support-Chat invite link: [support@conference.monocles.de](https://monocles.chat/)
If we can't fix your problem there, you can open an issue [here](https://codeberg.org/Arne/monocles_chat/issues), detailing your problem, how to reproduce it and provide logs. See instructions below on how to create log files.
### How to create debug logs? (adb)
#### GNU/Linux, OSX and other Unix-like systems:
1. First install The **A**ndroid **D**ebugging **B**ridge, if not already present.
###### Debian and derivates like Ubuntu / Linux Mint
```
sudo apt-get update
sudo apt-get update adb
# Debian Jessie or older:
# sudo apt-get install android-tools-adb
```
###### openSUSE 42.2 and 42.3
```
sudo zypper ref
sudo zypper install android-tools
```
###### openSUSE Tumbleweed
here you need to add the following repo (e.g. via Yast):
http://download.opensuse.org/repositories/hardware/openSUSE_Tumbleweed/
alternatively you have the option to use the `1 Click installer`
https://software.opensuse.org/package/android-tools
###### other systems
install adb using a method appropriate for your system
2. Now open a terminal in a directory of you're choice, or navigate to the directory using `cd`.
3. Follow steps [6] to [10] of the Windows instructions.
4. Start outputting your log to a file on your computer. We will be using `logcat.txt`. Enter:
```
$ adb -d logcat -v time | grep -i monocles_chat > logcat.txt
```
5. Follow the remaining steps [12] and [13] of the Windows instructions.
#### Windows:
1. Download Google's SDK-platform tools for your operating system:
https://developer.android.com/studio/releases/platform-tools.html
2. In case they were not included: You also need the ADB_drivers for your version of Microsoft Windows:
https://developer.android.com/studio/run/win-usb.html
3. Extract the zip-archive (e.g. to `C:\ADB\`)
4. Open the command line (CMD) using the start menu: Start > Execute: cmd
5. Navigate to the directory you extracted the zip to as following. We will be using `C:\ADB\`
```
c:
cd ADB
```
6. On your smartphone open the settings and search for the item `Developer Options`. If this option is not already present on your phone you will need to unlock it beforehand. To do this navigate to `Settings > About phone`, there locate `Build number` (or similar) and tap it 7-times in succession. You should now see a notification, that you are now a developer. Congrats, `Developer Options` are now available in your settings menu.
7. Inside `Developer Options` search activate the setting `USB-Debugging` (sometimes just called `Android Debugging`).
8. Connect your phone to your computer via USB cable. The necessary drivers should now be downloaded and installed if not already present. On Windows all necessary drivers should be downloaded automatically if you followed step [2] beforehand. On most GNU/Linux systems no additional action is required.
9. If everything worked out, you can now return to the command line and test if your device is being recognised. Enter `adb devices -l`; you should see output similar to:
```
> adb devices -l
List of devices attached
* daemon not running. starting it now on port 5037 *
* daemon started successfully *
042111560169500303f4 unauthorized
```
10. If your devices is labelled as `unautorized`, you must first accept a prompt on your phone asking if debugging over USB should be allowed. When rerunning `adb devices` you should now see:
```
> adb devices
List of devices attached
042111560169500303f4 device
```
11. Start outputting your log to a file on your computer. We will be using `logcat.txt` in `C:\ADB\`. Just enter the following (without `> ` into the command line):
```
> adb -d logcat -v time | FINDSTR monocles_chat > logcat.txt
```
12. Now reproduce the issue encountered.
13. Stop logging (`Ctrl+C`). Now take a close look at your log file and remove any personal and private information you may find before sending it together with a detailed description of your issue, instructions on how to reproduce to me. You can use GitHub's issue tracker: [Issues](https://github.com/kriztan/Monocles-Messenger/issues)

135
README-fr.md Normal file
View file

@ -0,0 +1,135 @@
# Annonce:
## Monocles Messenger devient monocles chat
Ce que vous pouvez attendre :
- La gamme de fonctions reste la même
- Les salons de chat du support sont fusionnés
- Les couleurs et les logos sont adaptés au chat de monocles.
- L'application est toujours disponible gratuitement sur codeberg et F-Droid Store.
L'équipe monocles
-----
# <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/src/main/ic_launcher-playstore.png" width="30"> monocles chat
🇩🇪… [Deutsche Version der Readme hier verfügbar.](README.md) / 🇬🇧🇺🇸… [English Readme version available here](README-en.md)
monocles chat est un fork de blabber.im et [Conversations] (https://github.com/siacs/Conversations).
Les changements visent à améliorer la convivialité et à faciliter la transition depuis les chats préinstallés et d'autres chats répandus. Voici quelques captures d'écran :
<img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/00.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/01.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/02.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/03.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/04.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/05.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/06.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/07.png" width="200" />
## Télécharger
monocles chat est disponible dans F-Droid
Alternativement, les APKs de la release et de la beta-release sont disponibles via codeberg : [Releases](https://codeberg.org/Arne/monocles_chat/releases/latest)
#### monocles chat nightly et beta
Les APK nightly ou beta-release sont disponibles via codeberg : [Releases](https://codeberg.org/Arne/monocles_chat/releases/nightly)
## Réseaux sociaux
Suivez-nous sur <a rel="me" href="https://monocles.social/@monocles">monocles social</a>
Il existe également des sales XMPP anglophones et germanophones qui se concentrent sur le support et le développement de monocles chat.
Si vous êtes intéressé par le développement du chat, voici un MUC pour vous (en anglais et en allemand) :
Développement-Chat : [development@conference.monocles.de](https://monocles.chat/)
Il existe également un Support-MUC où vous pouvez poser des questions et obtenir de l'aide pour les problèmes que vous pouvez rencontrer, voir ci-dessous pour plus de détails.
## Comment puis-je aider à la traduction ?
Vous pouvez créer une demande de fusion et ajouter de nouvelles langues en tant que locales et ajouter et modifier des traductions déjà existantes.
## Aidez-moi ! J'ai rencontré des problèmes !
La façon la plus simple d'obtenir de l'aide est de rejoindre notre support-MUC (en anglais et en allemand).
Lien d'invitation à la discussion de soutien : [support@conference.monocles.eu]
Si nous ne pouvons pas résoudre votre problème, vous pouvez ouvrir une question [ici](https://codeberg.org/Arne/monocles_chat/issues), en détaillant votre problème, comment le reproduire et en fournissant des journaux. Voir les instructions ci-dessous sur la façon de créer des fichiers journaux.
### Comment créer des journaux de débogage ? (adb)
#### GNU/Linux, OSX et d'autres systèmes de type Unix :
1. Installez d'abord **A**ndroid **D**ebugging **B**ridge, si ce n'est pas déjà fait.
###### Debian et ses dérivés comme Linux Mint / Ubuntu
```
sudo apt-get update
sudo apt-get update adb
# Debian Jessie or older:
# sudo apt-get install android-tools-adb
```
###### openSUSE 42.2 et 42.3
```
sudo zypper ref
sudo zypper install android-tools
```
###### openSUSE Tumbleweed
ici, vous devez ajouter le dépôt suivant (par exemple via Yast) :
http://download.opensuse.org/repositories/hardware/openSUSE_Tumbleweed/
Vous avez également la possibilité d'utiliser le programme d'installation en un clic.
https://software.opensuse.org/package/android-tools
###### autres systèmes
installer adb en utilisant une méthode appropriée à votre système
2. Maintenant, ouvrez un terminal dans un répertoire de votre choix, ou naviguez vers le répertoire en utilisant `cd`.
3. Suivez les étapes [6] à [10] des instructions Windows.
4. Commencez à sortir votre journal dans un fichier sur votre ordinateur. Nous allons utiliser `logcat.txt`. Entrez :
```
$ adb -d logcat -v time | grep -i monocles_chat > logcat.txt
```
5. Suivez les autres étapes [12] et [13] des instructions Windows.
#### Windows:
1. Téléchargez les outils de la plateforme SDK de Google pour votre système d'exploitation :
https://developer.android.com/studio/releases/platform-tools.html
2. Au cas où ils n'auraient pas été inclus : Vous avez également besoin des ADB_drivers pour votre version de Microsoft Windows :
https://developer.android.com/studio/run/win-usb.html
3. Extrayez l'archive zip (par exemple vers "C:\ADB\").
4. Ouvrez la ligne de commande (CMD) à l'aide du menu Démarrer : Démarrer > Exécuter : cmd
5. Naviguez vers le répertoire dans lequel vous avez extrait le zip comme suit. Nous allons utiliser `C:\ADB\`.
```
c:
cd ADB
```
6. Sur votre smartphone, ouvrez les paramètres et recherchez "Options développeur". Si cette option n'est pas déjà présente sur votre téléphone, vous devrez le déverrouiller au préalable. Pour ce faire, allez dans `Paramètres > À propos du téléphone`, localisez le `Numéro de construction` (ou similaire) et appuyez dessus 7 fois de suite. Vous devriez maintenant voir une notification indiquant que vous êtes maintenant un développeur. Félicitations, les `Options développeur` sont maintenant disponibles dans votre menu de paramètres.
7. Dans la recherche `Options développeur`, activez le paramètre `USB-Debugging` (parfois juste appelé `Android Debugging`).
8. Connectez votre téléphone à votre ordinateur via un câble USB. Les pilotes nécessaires doivent maintenant être téléchargés et installés s'ils ne sont pas déjà présents. Sous Windows, tous les pilotes nécessaires devraient être téléchargés automatiquement si vous avez suivi l'étape [2] au préalable. Sur la plupart des systèmes GNU/Linux, aucune action supplémentaire n'est requise.
9. Si tout a fonctionné, vous pouvez maintenant retourner à la ligne de commande et tester si votre périphérique est reconnu. Entrez `adb devices -l` ; vous devriez voir une sortie similaire à celle-ci :
```
> adb devices -l
List of devices attached
* daemon not running. starting it now on port 5037 *
* daemon started successfully *
042111560169500303f4 unauthorized
```
10. Si votre appareil est étiqueté comme `unautorized`, vous devez d'abord accepter une invite sur votre téléphone demandant si le débogage par USB doit être autorisé. En relançant `adb devices` vous devriez maintenant voir :
```
> adb devices
List of devices attached
042111560169500303f4 device
```
11. Commencez à sortir votre journal dans un fichier sur votre ordinateur. Nous allons utiliser `logcat.txt` dans `C:\ADB\`. Entrez simplement ce qui suit (sans `> ` dans la ligne de commande) :
```
> adb -d logcat -v time | FINDSTR monocles_chat > logcat.txt
```
12. Reproduisez maintenant le problème rencontré.
13. Arrêtez la journalisation (`Ctrl+C`). Maintenant, regardez attentivement votre fichier de log et supprimez toute information personnelle et privée que vous pourriez trouver avant de me l'envoyer avec une description détaillée de votre problème et des instructions sur la façon de le reproduire. Vous pouvez utiliser le gestionnaire de problèmes de GitHub : [Issues](https://github.com/kriztan/Monocles-Messenger/issues)

117
README.md
View file

@ -1,40 +1,105 @@
# monocles chat # <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/src/main/ic_launcher-playstore.png" width="30"> monocles chat
This is a fork of [Conversations](https://conversations.im) to implement features of use to the [Sopranica](https://soprani.ca) project. 🇬🇧🇺🇸… [English Readme version available here](README-en.md) / [Francais ici](README-fr.md)
The monocles chat app allows you to join a worldwide communication network. It especially focuses on features useful to users who want to contact those on other networks as well, such as SMS-enabled phone numbers. monocles chat ist moderner und sicherer Android XMPP-Client. Basierend auf blabber.im und der offiziellen Android-App [Conversations](https://github.com/siacs/Conversations) mit einigen Änderungen, insbesondere zur Verbesserung der Benutzerfreundlichkeit, um den Umstieg von oftmals vorinstallierten Messengern zu erleichtern. Die folgenden Bilder geben erste Eindrücke der App:
Based on the app Conversations, but with unique features: <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/00.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/01.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/02.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/03.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/04.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/05.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/06.png" width="200" /> <img src="https://codeberg.org/Arne/monocles_chat/raw/branch/master/fastlane/metadata/android/en-US/phoneScreenshots/07.png" width="200" />
* Messages with both media and text, including animated media Vorschaubilder erstellt von Pigeonalley (https://pigeonalley.com)
* Unobtrusive display of subject lines, where present
* Links to known contacts are shown with their name
* Show timestamps for calls
* Integrates with gateways' add contact flows
* When using a gateway to the phone network, integrate with the native Android Phone app
* Address book integration
* Tag contacts and channels and browse by tag
* Command UI
## Getting Help Download ist hier möglich:
<a href="https://f-droid.org/app/de.monocles.chat"><img src="https://f-droid.org/badge/get-it-on-de.png" alt="Jetzt bei F-Droid" height="100"></a>
If you have any questions about this app, or wish to report a bug, please send email to dev@singpolyma.net or join us in [xmpp:support@conference.monocles.eu?join](xmpp:support@conference.monocles.eu?join) Folge uns auf <a rel="me" href="https://monocles.social/@monocles">monocles social</a>
## Contributing #### monocles chat nightly bzw. beta
If you have code or patches you wish to contribute, the maintainer's preferred mechanism is a git pull request. Push your changes to a git repository somewhere, for example: nightly oder beta Versionen kann man direkt hier von Codeberg unter [Releases](https://codeberg.org/Arne/monocles_chat/releases) herunterladen.
git remote rename origin upstream #### Wie kann ich bei der Übersetzung helfen?
git remote add origin git@git.sr.ht:~yourname/cheogram-android Du kannst einen Merge Request erstellen in dem du Verbesserungen oder neue Sprachen hinzugefügt hast.
git push -u origin master
Then generate the pull request: #### Ich habe Probleme, was soll ich tun?
Am einfachsten ist es, wenn du unserer Support-Gruppe beitrittst, dort werden deine Probleme mit Sicherheit schnell gelöst.
git fetch upstream master Support-Chat: [support@conference.monocles.eu](https://monocles.chat)
git request-pull -p upstream/master origin
And copy-paste the result into a plain-text email to: dev@singpolyma.net Development-Chat: [development@conference.monocles.de](https://monocles.chat)
You may alternately use a patch-based approach as described on https://git-send-email.io
Contributions follow an inbound=outbound model -- you (or your employer) keep all copyright on your patches, but agree to license them according to this project's COPYING file. Solltest du dort nicht weiter kommen kannst du [hier](https://codeberg.org/Arne/monocles_chat/issues) ein Issue erstellen, in welchem du dein Problem genau beschreibst und welche Schritte erforderlich sind, um zu dem Problem zu gelangen.
#### Wie erstelle ich Debug- bzw. ADB-Logs?
##### Linux:
1. Installation von ADB
###### Debian und Derivate wie Ubuntu / Linux Mint
```
sudo apt-get update
sudo apt-get install adb
# For Debian Jessie and older
# sudo apt-get install android-tools-adb
```
###### openSUSE 42.2 und 42.3
```
sudo zypper ref
sudo zypper install android-tools
```
###### openSUSE Tumbleweed
hier muss für das benötigte Packet folgende Repo eingebunden werden (z.B. bequem über Yast):
http://download.opensuse.org/repositories/hardware/openSUSE_Tumbleweed/
alternativ kann auch der `1 Click Installer` benutzt werden:
https://software.opensuse.org/package/android-tools
2. Navigiere im Terminal mit `cd` in das Verzeichnis deines Vertrauens
3. Folge den Schritten [6] bis [10] unter [Windows]. s.u.
4. Nun kannst du mit der Ausgabe der Debug-Logs beginnen. Nenne die Log-Datei bspw `logcat.txt`:
```
$ adb -d logcat -v time | grep -i monocles_chat > logcat.txt
```
5. Fahre nun mit den verbliebenen Schritten unter [Windows] ab Schritt [12] fort.
##### Windows:
1. Lade dir die SDK-Plattform-Tools für dein Betriebssystem von Google herunter:
https://developer.android.com/studio/releases/platform-tools.html
2. Falls noch nicht getan, lade dir die ADB Treiber für dein Betriebssystem von Google herunter, für Windows hier:
https://developer.android.com/studio/run/win-usb.html
3. Entpacke die zip (z.B. nach C:\ADB\)
4. Öffne die Kommandozeile (CMD) mit Start > Ausführen: cmd
5. Wechsele in der Kommandozeile in das Verzeichnis C:\ADB wie folgt
```
c:
cd ADB
```
6. Auf deinem Telefon gehst du in die Einstellungen und suchst nach dem Punkt `Entwickleroptionen`. Sollte dieser bei dir nicht vorhanden sein, musst du diese Optionen erst noch freischalten. Dazu wechselst du in den Einstellungen in den Punkt `über das Telefon` und suchst dort nach `Buildnummer` oder Ähnlichem. Diese Zeile musst Du mindestens 7 mal hintereinander antippen, es sollte dann ein Hinweis eingeblendet werden, der dir bestätigt, dass du nun Entwickler bist.
7. In den `Entwickleroptionen` suchst du nach dem Eintrag `USB-Debugging` und aktivierst ihn.
8. Schließe dein Handy mit dem USB-Kabel an deinen PC an. Die erforderlichen Treiber sollten zumindest in Windows automatisch installiert werden.
9. Wenn alles ohne Fehler geklappt hat, kannst du wieder in die Kommandozeile gehen und testen, ob alles funktioniert. Gib dazu in CMD `adb devices -l` ein, es sollte in etwa sowas bei dir stehen:
```
> adb devices -l
List of devices attached
* daemon not running. starting it now on port 5037 *
* daemon started successfully *
042111560169500303f4 unauthorized
```
10. Falls dein Handy als `unauthorized` markiert wird, sollte am Handy eine Meldung `USB-Debugging zulassen?` kommen, diese mit `OK` bestätigen, sodass bei `adb devices` folgendes dort stehen sollte:
```
> adb devices
List of devices attached
042111560169500303f4 device
```
11. Nun kannst du mit der Ausgabe der Debug-Logs beginnen. Dazu gibst du im CMD folgendes ein und die Ausgabe beginnt in die Datei `logcat.txt` im Verzeichnis `C:\ADB`:
```
> adb -d logcat -v time | FINDSTR monocles_chat > logcat.txt
```
12. Führe nun die Schritte aus, die zum Fehler führen.
13. Nachdem der Fehler reproduziert wurde, kann das Loggen im Terminal mit `Strg+C` beendet werden.
14. Zum Schluss schaue dir die `logcat.txt` an, lösche ggf. persönliche Angaben und sende diese Datei zur Problemlösung mit einer Beschreibung des Fehlers und was man tun muss, um diesen Fehler zu erhalten, an mich. Nutz dafür den Menüpunkt [Issues](https://codeberg.org/Arne/monocles_chat/issues)