Mercurial > libervia-desktop-kivy

view doc/installation.rst @ 495:59bdf78bd1d9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
installation: update to use hatch following change in backend and other frontends: - `setup.py` and `requirements.txt` have been removed in favor of `pyproject.toml` - changed versionning mechanism to use a version directly in `libervia/desktop_kivy/__init__.py` handled by Hatch - remove the log hack from `kivy_hack` as there is now an environment variable to disable the logging hijacking
author Goffi <goffi@goffi.org>
date Mon, 28 Aug 2023 18:29:18 +0200
parents b3cedbee561d
children
line wrap: on
line source

============
Installation
============

This are the instructions to install Libervia Desktop-Kivy using Python.
Note that if you are using GNU/Linux, Libervia Desktop-Kivy may already be present on your distribution.

Libervia Desktop-Kivy is a frontend, the Libervia backend must be installed first (if you
haven't installed it yet, it will be downloaded automatically as it is a dependency of
Libervia Desktop-Kivy). Libervia Desktop-Kivy and Libervia Backend must always have the
same version.

We recommend to use development version for now.

Development Version
-------------------

The simplest way to install Libervia Desktop-Kivy at the moment is with `pipx`_::

  $ pipx install --system-site-packages hg+https://repos.goffi.org/libervia-desktop#egg=libervia-desktop

Usage
=====

To launch Libervia Desktop-Kivy enter::

  $ libervia-desktop_kivy

If you want to connect directly a profile::

  $ libervia-desktop_kivy -p profile_name

Once started, you can use ``F11`` to switch fullscreen mode.

You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``.

In Libervia Desktop-Kivy, notifications appear on the top of the screen, in the
*notification bar*. They appear for a few seconds, but you can click on the left Libervia
Desktop-Kivy icon to see them entirely and take your time to read them.

There is no focus stealing pop-up in Libervia Desktop-Kivy, when some event requires a
user action, a Libervia Desktop-Kivy icon will appear on the right of notification bar, so
user can click and interact with it when it is suitable.

Libervia Desktop-Kivy has a concept of **activities**. An activity is some kind of
communication tool (chat, file sharing, remote control, etc.). On top left of each
activity you have an icon representing the activity selected. Click on it to select
something else.

You may have noticed the 3 small dots on top and left border of each activity. You can
click (or touch) them, and drag to the bottom or right to create a new activity. This way
you can do several things on the same screen (e.g. check several chat rooms, or use the
file sharing and the chat at the same time). To close this extra activity, click again on
the 3 dots and drag in the opposite direction until the top or left line become red, then
release your mouse.

.. _pipx: https://pypa.github.io/pipx/