Mercurial > libervia-desktop-kivy

annotate README.md @ 504:fe0bdc476576

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
install: update `plyer` version
author Goffi <goffi@goffi.org>
date Wed, 25 Oct 2023 15:22:19 +0200
parents a4a5565e7026
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
1 # Libervia Desktop/Mobile (Kivy)
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
2
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
3 ### Copyrights
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
4
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
5 - Jérôme Poisson aka Goffi 2016-2023
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
6
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
7 ## License
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
8
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
9 Libervia Desktop (Kivy) is a Libre software (Free as in "Freedom"), distributed under the
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
10 AGPL v3+ license. For the full license, please refer to the `COPYING` file.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
11
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
12 ## About
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
13
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
14 Libervia Desktop (Kivy) is a Desktop/Android frontend for the [Libervia
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
15 project](https://libervia.org). This version serves as an alternative desktop frontend,
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
16 built using the [Kivy](https://kivy.org/) framework, alongside the main Qt-based frontend.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
17 It provides a native graphical interface optimized for touch-screen capabilities when
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
18 available and includes a split ability inspired by Blender. Although the frontend is
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
19 actively developed with a focus on GNU/Linux platforms, plans are underway to extend
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
20 support to other systems. An Android port is also in the early stages of development.
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
21
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
22 ### Features
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
23
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
24 - **Chat**: Supports text-based conversations with end-to-end encryption.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
25 - **File Sharing**: Offers the ability to share files, including peer-to-peer directory
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
26 sharing.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
27 - **Remote Control**: Implements XMPP Ad-Hoc commands, featuring a specialized mode for
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
28 controlling media players via icon-based UI.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
29 - **Contact Management**: Basic functionality for managing your contacts.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
30 - **Blogging**: Supports basic blogging features.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
31 - **Settings Management**: Allows users to adjust various settings of Libervia.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
32 - **Split Screen**: Provides the capability to split the screen by dragging and dropping
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
33 borders, enabling simultaneous view of multiple widgets.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
34 - **Multiple Windows**: On desktop environments, users can open another window, useful for
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
35 multi-screen setups.
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
36 - 🚧 **Audio/Video Calls** (WIP): One-to-one audio and video calling features are under
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
37 development and will be available in future releases.
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
38
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
39 Due to its modular architecture, the frontend is built to be customizable. Some features
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
40 available in other Libervia frontends (like calendars) are not yet implemented here.
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
41
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
42 For additional information, you can refer to the [Official Website](https://libervia.org).
80
370f00711640 added README
Goffi <goffi@goffi.org>
parents:
diff changeset
43
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
44 ## Contributions
128
d3ebe8caa26b README: added contribution URIs
Goffi <goffi@goffi.org>
parents: 80
diff changeset
45
d3ebe8caa26b README: added contribution URIs
Goffi <goffi@goffi.org>
parents: 80
diff changeset
46 Here are the URIs you can use to publish/retrieve tickets or merge requests:
d3ebe8caa26b README: added contribution URIs
Goffi <goffi@goffi.org>
parents: 80
diff changeset
47
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
48 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "desktop-kivy" label)
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
49 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "desktop-kivy" label)
128
d3ebe8caa26b README: added contribution URIs
Goffi <goffi@goffi.org>
parents: 80
diff changeset
50
494
a4a5565e7026 doc (README): move to README.md to use Markdown, and update content
Goffi <goffi@goffi.org>
parents: 461
diff changeset
51 Tickets and merge requests are handled by Libervia itself using XMPP.