annotate doc/installation.rst @ 465:02787fa81b81

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