# HG changeset patch # User Goffi # Date 1693235355 -7200 # Node ID a4a5565e7026587bc916deedbae4b0d7c747401b # Parent b3cedbee561da7605a9d31d2a3c3c5adbaad0349 doc (README): move to README.md to use Markdown, and update content diff -r b3cedbee561d -r a4a5565e7026 README --- a/README Fri Jun 02 18:26:16 2023 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,41 +0,0 @@ -Cagou -(c) Jérôme Poisson aka Goffi 2016-2021 - -Cagou is a Salut à Toi (SàT) desktop/mobile devices frontend -SàT is a XMPP (Jabber) client. - -** LICENCE ** - -Cagou is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -Cagou is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with Cagou. If not, see . - - -** ABOUT ** - -Cagou is a desktop/mobile devices frontend for the "Salut à Toi" (SàT) XMPP client. Please check SàT for more information (it's anyway needed to run Cagou) - -** How to use it ? ** - -Refer to the wiki for installation/use instructions: -https://wiki.goffi.org/wiki/S%C3%A0T - -refer to SàT README for more informations: credits, contributors, and contact informations stand there. - -** CONTRIBUTIONS ** - -Here are the URIs you can use to publish/retrieve tickets or merge requests: - -tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "cagou" label) -merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "cagou" label) - -Tickets and merge requests are handled by SàT itself using XMPP. diff -r b3cedbee561d -r a4a5565e7026 README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Mon Aug 28 17:09:15 2023 +0200 @@ -0,0 +1,51 @@ +# Libervia Desktop/Mobile (Kivy) + +### Copyrights + +- Jérôme Poisson aka Goffi 2016-2023 + +## License + +Libervia Desktop (Kivy) is a Libre software (Free as in "Freedom"), distributed under the +AGPL v3+ license. For the full license, please refer to the `COPYING` file. + +## About + +Libervia Desktop (Kivy) is a Desktop/Android frontend for the [Libervia +project](https://libervia.org). This version serves as an alternative desktop frontend, +built using the [Kivy](https://kivy.org/) framework, alongside the main Qt-based frontend. +It provides a native graphical interface optimized for touch-screen capabilities when +available and includes a split ability inspired by Blender. Although the frontend is +actively developed with a focus on GNU/Linux platforms, plans are underway to extend +support to other systems. An Android port is also in the early stages of development. + +### Features + +- **Chat**: Supports text-based conversations with end-to-end encryption. +- **File Sharing**: Offers the ability to share files, including peer-to-peer directory + sharing. +- **Remote Control**: Implements XMPP Ad-Hoc commands, featuring a specialized mode for + controlling media players via icon-based UI. +- **Contact Management**: Basic functionality for managing your contacts. +- **Blogging**: Supports basic blogging features. +- **Settings Management**: Allows users to adjust various settings of Libervia. +- **Split Screen**: Provides the capability to split the screen by dragging and dropping + borders, enabling simultaneous view of multiple widgets. +- **Multiple Windows**: On desktop environments, users can open another window, useful for + multi-screen setups. +- 🚧 **Audio/Video Calls** (WIP): One-to-one audio and video calling features are under + development and will be available in future releases. + +Due to its modular architecture, the frontend is built to be customizable. Some features +available in other Libervia frontends (like calendars) are not yet implemented here. + +For additional information, you can refer to the [Official Website](https://libervia.org). + +## Contributions + +Here are the URIs you can use to publish/retrieve tickets or merge requests: + +tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "desktop-kivy" label) +merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "desktop-kivy" label) + +Tickets and merge requests are handled by Libervia itself using XMPP.