# HG changeset patch # User Goffi # Date 1600002082 -7200 # Node ID d1032f9ece5be3ac70370a302974d66805d8e941 # Parent d100d3a07dd76eb803accbb5ffb2f4166591f48f doc: updated installation instructions diff -r d100d3a07dd7 -r d1032f9ece5b doc/installation.rst --- a/doc/installation.rst Sat Sep 05 21:59:38 2020 +0200 +++ b/doc/installation.rst Sun Sep 13 15:01:22 2020 +0200 @@ -11,11 +11,7 @@ start if the version backend has not the same version). We recommend to use development version for now, until the release of -0.7 version which will be "general public" version. - -Also note that Libervia as all SàT ecosystem is still using Python 2 (this will change for -0.8 version which will be Python 3 only), so all instructions below have to be made using -python 2. +0.8 version. Development Version ------------------- @@ -32,11 +28,12 @@ $ cd -And enter the following commands (note that *virtualenv2* may be named -*virtualenv* on some distributions, just be sure it's Python **2** version):: +And enter the following commands (note that *virtualenv3* may be named +*virtualenv* on some distributions, just be sure it's Python **3** version):: - $ virtualenv2 env - $ source env/bin/activate + $ python3 -m venv sat + $ source sat/bin/activate + $ pip install wheel $ pip install hg+https://repos.goffi.org/libervia If you haven't done it for the backend, you need to install the media:: @@ -44,6 +41,30 @@ $ cd $ hg clone https://repos.goffi.org/sat_media +then, create the directory ``~/.config/sat``:: + + $ mkdir -p ~/.config/sat + +and the file ``~/.config/sat/sat.conf`` containing: + +.. sourcecode:: cfg + + [DEFAULT] + media_dir = ~/sat_media + +Of course, replace ``~/sat_media`` with the actual path you have used. + +Please check backend documentation for more details on the settings. + +You'll also need the ``yarn`` packager, please check your distribution documentation for +instructions to install it. + +.. note:: + + On Debian and derivatives, the ``yarn`` packager is installed with the ``yarnpkg`` + package (and not ``yarn`` only), you can install it with ``apt install yarnpkg`` as + root (or with ``sudo``). + Post Installation -----------------