Mercurial > libervia-desktop-kivy
annotate 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 |
| rev | line source |
|---|---|
| 307 | 1 ============ |
| 2 Installation | |
| 3 ============ | |
| 4 | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
5 This are the instructions to install Libervia Desktop-Kivy using Python. |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
6 Note that if you are using GNU/Linux, Libervia Desktop-Kivy may already be present on your distribution. |
| 307 | 7 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
8 Libervia Desktop-Kivy is a frontend, the Libervia backend must be installed first (if you |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
9 haven't installed it yet, it will be downloaded automatically as it is a dependency of |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
10 Libervia Desktop-Kivy). Libervia Desktop-Kivy and Libervia Backend must always have the |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
11 same version. |
| 307 | 12 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
13 We recommend to use development version for now. |
| 307 | 14 |
| 15 Development Version | |
| 16 ------------------- | |
| 17 | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
18 The simplest way to install Libervia Desktop-Kivy at the moment is with `pipx`_:: |
| 307 | 19 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
20 $ pipx install --system-site-packages hg+https://repos.goffi.org/libervia-desktop#egg=libervia-desktop |
| 307 | 21 |
| 22 Usage | |
| 23 ===== | |
| 24 | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
25 To launch Libervia Desktop-Kivy enter:: |
| 307 | 26 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
27 $ libervia-desktop_kivy |
| 307 | 28 |
| 29 If you want to connect directly a profile:: | |
| 30 | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
31 $ libervia-desktop_kivy -p profile_name |
| 307 | 32 |
| 33 Once started, you can use ``F11`` to switch fullscreen mode. | |
| 34 | |
| 35 You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``. | |
| 36 | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
37 In Libervia Desktop-Kivy, notifications appear on the top of the screen, in the |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
38 *notification bar*. They appear for a few seconds, but you can click on the left Libervia |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
39 Desktop-Kivy icon to see them entirely and take your time to read them. |
| 307 | 40 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
41 There is no focus stealing pop-up in Libervia Desktop-Kivy, when some event requires a |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
42 user action, a Libervia Desktop-Kivy icon will appear on the right of notification bar, so |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
43 user can click and interact with it when it is suitable. |
| 307 | 44 |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
45 Libervia Desktop-Kivy has a concept of **activities**. An activity is some kind of |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
46 communication tool (chat, file sharing, remote control, etc.). On top left of each |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
47 activity you have an icon representing the activity selected. Click on it to select |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
48 something else. |
| 307 | 49 |
| 50 You may have noticed the 3 small dots on top and left border of each activity. You can | |
| 51 click (or touch) them, and drag to the bottom or right to create a new activity. This way | |
| 52 you can do several things on the same screen (e.g. check several chat rooms, or use the | |
| 53 file sharing and the chat at the same time). To close this extra activity, click again on | |
| 54 the 3 dots and drag in the opposite direction until the top or left line become red, then | |
| 55 release your mouse. | |
|
493
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
56 |
|
b3cedbee561d
refactoring: rename `cagou` to `libervia.desktop_kivy` + update imports and names following backend changes
Goffi <goffi@goffi.org>
parents:
307
diff
changeset
|
57 .. _pipx: https://pypa.github.io/pipx/ |