From 2ae79ea06f202c6427b947306995b748cca34ec0 Mon Sep 17 00:00:00 2001
From: Evangelos Ribeiro Tzaras <evangelos.tzaras@puri.sm>
Date: Thu, 3 Jun 2021 13:09:42 +0200
Subject: [PATCH] Update README: Explain how to start calls without installing

Additionally get rid of the /usr/local/stow/calls-git prefix.
---
 README.md | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 75707dd..307071c 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,20 @@ If you are running a Debian based distribution, you can easily install all those
 We use the meson and thereby Ninja.  The quickest way to get going is
 to do the following:
 
-    meson -Dprefix=/usr/local/stow/calls-git ../calls-build
-    ninja -C ../calls-build
-    ninja -C ../calls-build install
+    meson . _build
+    ninja -C _build
+    ninja -C _build install
 
+If you don't want to pollute your filesystem please be aware, that you can also
+use `--prefix=~/install`.
+
+### Build the documentation
+If you want to build the documentation you have to configure the meson project
+with `-Ggtk_doc=true`
+
+    meson . _build -Dgtk_doc=true
+    ninja -C _build
+    ninja -C _build calls-doc
 
 ## Running
 Calls has a variety of backends.  The default backend is "mm", which
@@ -31,18 +41,23 @@ command-line option.  For example, to run with the dummy backend and
 some useful debugging output:
 
     export G_MESSAGES_DEBUG=all
-    /usr/local/stow/calls-git/bin/calls -p dummy
+    /usr/bin/gnome-calls -p dummy
 
 If using ModemManager, Calls will wait for ModemManager to appear on
 D-Bus and then wait for usable modems to appear.  The UI will be
 inactive and display a status message until a usable modem appears.
 
-When running from the source tree you can use `CALLS_PLUGIN_DIR` environment
-varible to specify the directroy from where plugins are loaded. To e.g. load
-the dummy plugin from the source tree:
+### Running from the build directory
+You can run calls without having to install it by executing the run script in
+the build folder, i.e. `_build/run`
+
+When running from the build tree you can use `CALLS_PLUGIN_DIR` environment
+varible to specify the directroy from where plugins are loaded. To e.g. load
+the dummy plugin from the build tree:
+
+    export CALLS_PLUGIN_DIR=_build/plugins/
+    _build/run -p dummy
 
-    export CALLS_PLUGIN_DIR=_build/plugins/dummy/
-    _build/src/gnome-calls -p dummy
 
 ### oFono
 There is also an oFono backend, "ofono".  This was the first backend
@@ -65,7 +80,7 @@ useful to bring up a modem to a suitable state.  For example:
 
 Then run Calls:
 
-    /usr/local/stow/calls-git/bin/calls -p ofono
+    /usr/bin/gnome-calls -p ofono
 
 
 #### Phonesim