Mercurial > libervia-desktop
comparison doc/installation.rst @ 307:aafd814e34b5
doc: first draft
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 23 Jul 2019 20:08:38 +0200 |
| parents | |
| children | b3cedbee561d |
comparison
equal
deleted
inserted
replaced
| 306:e2afbec1d178 | 307:aafd814e34b5 |
|---|---|
| 1 ============ | |
| 2 Installation | |
| 3 ============ | |
| 4 | |
| 5 This are the instructions to install Cagou (SàT) using Python. | |
| 6 Note that if you are using GNU/Linux, Cagou may already be present on your distribution. | |
| 7 | |
| 8 Cagou is a Salut à Toi frontend, the SàT backend must be installed first (if you | |
| 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. | |
| 11 | |
| 12 We recommend to use development version for now, until the release of 0.7 version which | |
| 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 | |
| 19 Development Version | |
| 20 ------------------- | |
| 21 | |
| 22 *Note for Arch users: a pkgbuild is available for your distribution on | |
| 23 AUR, check sat-cagou-hg (as well as other sat-\* packages).* | |
| 24 | |
| 25 You can install the latest development version using pip. Please check backend documentation | |
| 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 | |
| 46 Usage | |
| 47 ===== | |
| 48 | |
| 49 To launch Cagou enter:: | |
| 50 | |
| 51 $ cagou | |
| 52 | |
| 53 If you want to connect directly a profile:: | |
| 54 | |
| 55 $ cagou -p profile_name | |
| 56 | |
| 57 Once started, you can use ``F11`` to switch fullscreen mode. | |
| 58 | |
| 59 You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``. | |
| 60 | |
| 61 In Cagou, notifications appear on the top of the screen, in the *notification bar*. They | |
| 62 appear for a few seconds, but you can click on the left Cagou icon to see them entirely | |
| 63 and take your time to read them. | |
| 64 | |
| 65 There is no focus stealing pop-up in Cagou, when some event requires a user action, a Cagou | |
| 66 icon will appear on the right of notification bar, so user can click and interact with it | |
| 67 when it is suitable. | |
| 68 | |
| 69 Cagou has a concept of **activities**. An activity is some kind of communication tool | |
| 70 (chat, file sharing, remote control, etc.). On top left of each activity you have an icon | |
| 71 representing the activity selected. Click on it to select something else. | |
| 72 | |
| 73 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 | |
| 75 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 | |
| 77 the 3 dots and drag in the opposite direction until the top or left line become red, then | |
| 78 release your mouse. |