Mercurial > libervia-desktop-kivy
comparison doc/installation.rst @ 493:b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 02 Jun 2023 18:26:16 +0200 |
parents | aafd814e34b5 |
children |
comparison
equal
deleted
inserted
replaced
492:5114bbb5daa3 | 493:b3cedbee561d |
---|---|
1 ============ | 1 ============ |
2 Installation | 2 Installation |
3 ============ | 3 ============ |
4 | 4 |
5 This are the instructions to install Cagou (SàT) using Python. | 5 This are the instructions to install Libervia Desktop-Kivy using Python. |
6 Note that if you are using GNU/Linux, Cagou may already be present on your distribution. | 6 Note that if you are using GNU/Linux, Libervia Desktop-Kivy may already be present on your distribution. |
7 | 7 |
8 Cagou is a Salut à Toi frontend, the SàT backend must be installed first (if you | 8 Libervia Desktop-Kivy is a frontend, the Libervia backend must be installed first (if you |
9 haven't installed it yet, it will be downloaded automatically as it is a dependency of | 9 haven't installed it yet, it will be downloaded automatically as it is a dependency of |
10 Cagou). Cagou and SàT backend must always have the same version. | 10 Libervia Desktop-Kivy). Libervia Desktop-Kivy and Libervia Backend must always have the |
11 same version. | |
11 | 12 |
12 We recommend to use development version for now, until the release of 0.7 version which | 13 We recommend to use development version for now. |
13 will be "general public" version. | |
14 | |
15 Also note that Cagou as all SàT ecosystem is still using Python 2 (this will change for | |
16 0.8 version which will be Python 3 only), so all instructions below have to be made using | |
17 python 2. | |
18 | 14 |
19 Development Version | 15 Development Version |
20 ------------------- | 16 ------------------- |
21 | 17 |
22 *Note for Arch users: a pkgbuild is available for your distribution on | 18 The simplest way to install Libervia Desktop-Kivy at the moment is with `pipx`_:: |
23 AUR, check sat-cagou-hg (as well as other sat-\* packages).* | |
24 | 19 |
25 You can install the latest development version using pip. Please check backend documentation | 20 $ pipx install --system-site-packages hg+https://repos.goffi.org/libervia-desktop#egg=libervia-desktop |
26 to see the system dependencies needed. | |
27 | |
28 You can use the same virtual environment as the one used for installing the backend. If | |
29 you haven't installed it yet, just select a location when you want to install it, for | |
30 instance your home directory:: | |
31 | |
32 $ cd | |
33 | |
34 And enter the following commands (note that *virtualenv2* may be named | |
35 *virtualenv* on some distributions, just be sure it's Python **2** version):: | |
36 | |
37 $ virtualenv2 env | |
38 $ source env/bin/activate | |
39 $ pip install hg+https://repos.goffi.org/cagou | |
40 | |
41 If you haven't done it for the backend, you need to install the media:: | |
42 | |
43 $ cd | |
44 $ hg clone https://repos.goffi.org/sat_media | |
45 | 21 |
46 Usage | 22 Usage |
47 ===== | 23 ===== |
48 | 24 |
49 To launch Cagou enter:: | 25 To launch Libervia Desktop-Kivy enter:: |
50 | 26 |
51 $ cagou | 27 $ libervia-desktop_kivy |
52 | 28 |
53 If you want to connect directly a profile:: | 29 If you want to connect directly a profile:: |
54 | 30 |
55 $ cagou -p profile_name | 31 $ libervia-desktop_kivy -p profile_name |
56 | 32 |
57 Once started, you can use ``F11`` to switch fullscreen mode. | 33 Once started, you can use ``F11`` to switch fullscreen mode. |
58 | 34 |
59 You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``. | 35 You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``. |
60 | 36 |
61 In Cagou, notifications appear on the top of the screen, in the *notification bar*. They | 37 In Libervia Desktop-Kivy, notifications appear on the top of the screen, in the |
62 appear for a few seconds, but you can click on the left Cagou icon to see them entirely | 38 *notification bar*. They appear for a few seconds, but you can click on the left Libervia |
63 and take your time to read them. | 39 Desktop-Kivy icon to see them entirely and take your time to read them. |
64 | 40 |
65 There is no focus stealing pop-up in Cagou, when some event requires a user action, a Cagou | 41 There is no focus stealing pop-up in Libervia Desktop-Kivy, when some event requires a |
66 icon will appear on the right of notification bar, so user can click and interact with it | 42 user action, a Libervia Desktop-Kivy icon will appear on the right of notification bar, so |
67 when it is suitable. | 43 user can click and interact with it when it is suitable. |
68 | 44 |
69 Cagou has a concept of **activities**. An activity is some kind of communication tool | 45 Libervia Desktop-Kivy has a concept of **activities**. An activity is some kind of |
70 (chat, file sharing, remote control, etc.). On top left of each activity you have an icon | 46 communication tool (chat, file sharing, remote control, etc.). On top left of each |
71 representing the activity selected. Click on it to select something else. | 47 activity you have an icon representing the activity selected. Click on it to select |
48 something else. | |
72 | 49 |
73 You may have noticed the 3 small dots on top and left border of each activity. You can | 50 You may have noticed the 3 small dots on top and left border of each activity. You can |
74 click (or touch) them, and drag to the bottom or right to create a new activity. This way | 51 click (or touch) them, and drag to the bottom or right to create a new activity. This way |
75 you can do several things on the same screen (e.g. check several chat rooms, or use the | 52 you can do several things on the same screen (e.g. check several chat rooms, or use the |
76 file sharing and the chat at the same time). To close this extra activity, click again on | 53 file sharing and the chat at the same time). To close this extra activity, click again on |
77 the 3 dots and drag in the opposite direction until the top or left line become red, then | 54 the 3 dots and drag in the opposite direction until the top or left line become red, then |
78 release your mouse. | 55 release your mouse. |
56 | |
57 .. _pipx: https://pypa.github.io/pipx/ |