changeset 3558:d8581c83fef3

doc (installation): update instruction to use requirements + fix name in a few places
author Goffi <goffi@goffi.org>
date Wed, 09 Jun 2021 17:31:52 +0200
parents 940b6cfa17f1
children c8d980d694a7
files doc/installation.rst
diffstat 1 files changed, 23 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/doc/installation.rst	Wed Jun 09 17:30:52 2021 +0200
+++ b/doc/installation.rst	Wed Jun 09 17:31:52 2021 +0200
@@ -4,7 +4,7 @@
 Installation
 ============
 
-This are the instructions to install SàT using Python.
+This are the instructions to install Libervia using Python.
 Note that if you are using GNU/Linux, Libervia may already be present on your distribution.
 
 Libervia is made of one backend, and several frontends. To use it, the first thing to do is to install the backend.
@@ -42,19 +42,19 @@
 
   $ cd
 
-And enter the following commands (here we install SàT with SVG support, which is needed to
+And enter the following commands (here we install Libervia with SVG support, which is needed to
 display SVG avatars on some frontends)::
 
   $ python3 -m venv sat
   $ source sat/bin/activate
-  $ pip install wheel
-  $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat_templates "hg+https://repos.goffi.org/sat#egg=sat[SVG]"
+  $ pip install -U pip wheel
+  $ pip install -r requirements.txt
 
-Don't worry if you see the following message, SàT should work anyway::
+Don't worry if you see the following message, Libervia should work anyway::
 
   Failed building wheel for pygobject
 
-After installing SàT, you need to install the media::
+After installing Libervia, you need to install the media::
 
   $ cd
   $ hg clone https://repos.goffi.org/sat_media
@@ -93,22 +93,25 @@
 
   $ sat status
 
-**NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it.
+**NOTE**: if ``misc/org.libervia.Libervia.service`` is installed correctly (which should
+be done by during the installation), the backend is automatically launched when a frontend
+needs it.
 
-You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below)::
+You can check that Libervia is installed correctly by trying jp (the backend need to be
+launched first, check below)::
 
-  $ jp --version
-  jp 0.8.0D « La Cecília » (rev df26f1a9020a [M] (default 2020-04-14 21:01 +0200) +231) Copyright (C) 2009-2020 Jérôme Poisson, Adrien Cossa
+  $ li --version
+  Libervia CLI 0.8.0D « La Cecília » (rev 184c66256bbc [M] (default 2021-06-09 11:35 +0200) +524) Copyright (C) 2009-2021 Jérôme Poisson, Adrien Cossa
   This program comes with ABSOLUTELY NO WARRANTY;
   This is free software, and you are welcome to redistribute it under certain conditions.
 
-If you have a similar output, SàT is working.
+If you have a similar output, Libervia is working.
 
 .. note::
 
   if you have the message ``/!\ D-Bus is not launched, please see README to see
   instructions on how to launch it`` that mean that the D-Bus service is not launched, this
-  usually happens when launching SàT on a server, without graphic interface like X.org or
+  usually happens when launching Libervia on a server, without graphic interface like X.org or
   Wayland (in which case D-Bus service should be launcher automatically).
 
   As the message states, instructions on how to launch the service are given in the README
@@ -119,27 +122,27 @@
 
 So far, the following frontends exist and are actively maintained:
 
-Cagou
+Libervia Desktop (aka Cagou)
   desktop/mobile (Android) frontend
 
-Libervia
+Libervia Web
   the web frontend
 
-Primitivus
+Libervia TUI (aka Primitivus)
   Text User Interface
 
-jp
+Libervia CLI (aka jp or li)
   Command Line Interface
 
-To launch Primitivus, just type::
+To launch Libervia TUI, just type::
 
-  $ primitivus
+  $ libervia-tui
 
 then create a profile (XMPP account must already exist).
 
-To use jp, follow its help::
+To use Libervia CLI, follow its help (``li`` is a shortcut for ``libervia-cli``)::
 
-  $ jp --help
+  $ li --help
 
 
 There are some other frontends: