From 8980fe7838e400d4781ea50a4e76853a47c71c98 Mon Sep 17 00:00:00 2001 From: Tobias Fella Date: Sat, 13 Apr 2024 21:59:16 +0200 Subject: [PATCH] Improve README --- README.md | 48 +++++++++++++++++------------------------------- 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 2f7b6d3ca..87bc6640e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ @@ -16,19 +16,18 @@ A Qt/QML based Matrix client. ## Introduction NeoChat is a client for [Matrix](https://matrix.org), the decentralized communication protocol for instant -messaging. It is a fork of Spectral, using KDE frameworks, most notably [Kirigami](https://invent.kde.org/frameworks/kirigami) -to provide a convergent experience across multiple platforms. +messaging. -NeoChat also make use of other KDE Frameworks as well as [libQuotient](https://github.com/quotient-im/libQuotient), a +NeoChat is based on KDE frameworks and as [libQuotient](https://github.com/quotient-im/libQuotient), a Qt-based SDK for the [Matrix Protocol](https://spec.matrix.org/). ![Timeline](https://cdn.kde.org/screenshots/neochat/application.png) ## Features -NeoChat aims to be a fully featured application for the Matrix specification. As such everything in the current stable specification with the notable exceptions -of VoIP, threads and some aspects of End-to-End Encryption are supported. There are a few other smaller omissions due to the fact that the Matrix spec is constantly -evolving but the aim remains to provide eventual support for the entire spec. +NeoChat aims to be a fully featured application for the Matrix specification. As such most parts of the current specification are supported, with the notable exceptions +of VoIP, threads, and some aspects of End-to-End Encryption. There are a few other smaller omissions due to the fact that the Matrix spec is constantly +evolving, but the aim remains to provide eventual support for the entire spec. Due to the nature of the Matrix specification development NeoChat also supports numerous unstable features. Currently these are: - Polls - MSC3381 @@ -39,26 +38,9 @@ Due to the nature of the Matrix specification development NeoChat also supports Details where to find stable releases for NeoChat can be found on its [homepage](https://apps.kde.org/neochat). -In addition to the stable builds, unstable nightly builds are available for all platforms. These can be downloaded -from the [binary factory](https://binary-factory.kde.org/). There are unstable versions for the following platforms -in addition to stable ones: -- Android -- MacOS -- Windows - -Additionally the nightly Flatpak version can be obtained from the nightly Flatpak repo using the following commands in your terminal: - -``` -flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo -flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo -flatpak install kdeapps org.kde.neochat -``` - -The unstable Android version can also be obtained from the [KDE nightly F-Droid repo](https://community.kde.org/Android/FDroid). - -## Running - -Just start the executable in your preferred way - either from the build directory or from the installed location. +Nightly builds for linux and windows can be downloaded from [cdn.kde.org](https://cdn.kde.org/ci-builds/network/neochat/). +Nightly builds for android are available from [KDE's nightly F-Droid repository](https://community.kde.org/Android/F-Droid). +Nightly Flatpaks are available from [KDE's nightly Flatpak repository](https://userbase.kde.org/Tutorials/Flatpak). ## Building NeoChat @@ -69,14 +51,18 @@ is primarily aimed at Linux development. For Windows and Android [Craft](https://invent.kde.org/packaging/craft) is the primary choice. There are guides for setting up development environments for [Windows](https://community.kde.org/Get_Involved/development/Windows) and [Android](https://develop.kde.org/docs/packaging/android/building_applications/). +## Running + +Just start the executable in your preferred way - either from the build directory or from the installed location. + ## Tests -Tests are in the repository under [autotests](autotests) and should all pass for any contribution. +Tests are in the repository under [autotests](autotests) and [appiumtests](appiumtests). The project has CI setup to test new commits to the repository. All tests are expected to pass for a merge request to be complete. -Current build status +## Current build status ![coverage](https://invent.kde.org/network/neochat/badges/master/pipeline.svg) @@ -100,9 +86,9 @@ The best place to reach the maintainers is on the KDE Matrix instance in the Neo ## Acknowledgement -This program utilizes [libQuotient](https://github.com/quotient-im/libQuotient/) as its Matrix SDK. +NeoChat utilizes [libQuotient](https://github.com/quotient-im/libQuotient/) as its Matrix SDK. -This program is a fork of [Spectral](https://gitlab.com/spectral-im/spectral/). +NeoChat is a fork of [Spectral](https://gitlab.com/spectral-im/spectral/). ## License