From 5cc4890f0dad9444abfc63e499c6d194ea10b694 Mon Sep 17 00:00:00 2001
From: Goffi <goffi@goffi.org>
Date: Sun, 13 Sep 2020 22:49:11 +0200
Subject: [PATCH] doc: updated installation instructions

---
 doc/installation.rst | 22 +++++++++++++++++++---
 doc/overview.rst     |  6 +++---
 2 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/doc/installation.rst b/doc/installation.rst
index ff2b6a68..654b4a0e 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -21,6 +21,7 @@ You can install the latest development version using pip. You need to
 have the following dependencies installed first:
 
 -  Python 3 with development headers
+-  Python 3 "venv", which may be installed with Python 3
 -  Mercurial
 -  libcairo 2 with development headers
 -  libjpeg with development headers
@@ -34,7 +35,7 @@ have the following dependencies installed first:
 
 On Debian and derivatives, you can get all this with following command::
 
-  $ sudo apt-get install python-dev mercurial virtualenv libxml2-dev libxslt-dev libcairo2-dev libjpeg-dev libgirepository1.0-dev libdbus-1-dev libdbus-glib-1-dev dbus-x11 cmake
+  $ sudo apt-get install python3-dev python3-venv python3-wheel mercurial libxml2-dev libxslt-dev libcairo2-dev libjpeg-dev libgirepository1.0-dev libdbus-1-dev libdbus-glib-1-dev dbus-x11 cmake
 
 Now go in a location where you can install Salut à Toi, for
 instance your home directory::
@@ -46,7 +47,8 @@ display SVG avatars on some frontends)::
 
   $ python3 -m venv sat
   $ source sat/bin/activate
-  $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat#egg=sat[SVG]
+  $ pip install wheel
+  $ pip install hg+https://repos.goffi.org/sat_tmp "hg+https://repos.goffi.org/sat#egg=sat[SVG]"
 
 Don't worry if you see the following message, SàT should work anyway::
 
@@ -57,7 +59,11 @@ After installing SàT, you need to install the media::
   $ cd
   $ hg clone https://repos.goffi.org/sat_media
 
-then, create the file ~/.config/sat/sat.conf containing:
+then, create the directory ``~/.config/sat``::
+
+  $ mkdir -p ~/.config/sat
+
+and the file ``~/.config/sat/sat.conf`` containing:
 
 .. sourcecode:: cfg
 
@@ -98,6 +104,16 @@ You can check that SàT is installed correctly by trying jp (the backend need to
 
 If you have a similar output, SàT 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
+  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
+  file of Salut à Toi.
+
 Frontends
 =========
 
diff --git a/doc/overview.rst b/doc/overview.rst
index 8d7c03dc..6234cb7d 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -162,10 +162,10 @@ When you connect to a SàT frontend, you need to specify a profile and the assoc
 - profile password can be empty, in which case no password is requested when a profile is
   used
 
-  .. note::
+.. note::
 
-   if you use an empty profile password, the XMPP password won't be encrypted in database
-   (or more precisely, will be trivial to decrypt).
+ if you use an empty profile password, the XMPP password won't be encrypted in database
+ (or more precisely, will be trivial to decrypt).
 
 - a profile is a simple name associated with an account, it's easier to remember than a
   whole XMPP identifier (also named "JID" for *Jabber ID*)