From a0a74fd3c4571aa4abb2fb59f5d857a8f75c0c5f Mon Sep 17 00:00:00 2001
From: Andreas Motl <andreas@hiveeyes.org>
Date: Sun, 20 Jun 2021 22:19:13 +0200
Subject: [PATCH] Improve documentation

---
 CHANGES.rst     |  2 +-
 README.rst      | 19 +++++++++++--------
 doc/backlog.rst |  5 ++++-
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/CHANGES.rst b/CHANGES.rst
index 504ee7e..c9313fb 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -7,7 +7,7 @@ in progress
 ===========
 
 - Adjust recording pipeline: Add ``audioconvert ! queue`` GStreamer elements after audio source
-
+- Improve documentation
 
 2021-06-20 0.1.0
 ================
diff --git a/README.rst b/README.rst
index cac7be9..3142bdf 100644
--- a/README.rst
+++ b/README.rst
@@ -51,7 +51,7 @@ Hindu goddess of knowledge, music, art, wisdom and learning.
 Status
 ======
 
-The software was tested successfully with Python 3.x, GStreamer 1.10.4, 1.14.4
+The software was tested successfully with Python 3.7-3.9, GStreamer 1.10.4, 1.14.4,
 and 1.18.4, on both Linux and macOS.
 
 THIS IS A WORK IN PROGRESS. THERE MIGHT BE DRAGONS. YOU HAVE BEEN WARNED.
@@ -74,13 +74,13 @@ relevant packages.
 
 Debian-based systems
 --------------------
-GStreamer::
-
-    apt-get install gstreamer1.0 gstreamer1.0-tools gstreamer1.0-alsa gstreamer1.0-plugins-base gstreamer1.0-plugins-good
-
-Python and tools::
+::
 
-    apt-get install python3 python3-gst-1.0 python3-gi python3-tz mkvtoolnix
+    apt-get update
+    apt-get install --yes libgstreamer1.0 gstreamer1.0-tools gstreamer1.0-alsa gstreamer1.0-plugins-base gstreamer1.0-plugins-good
+    apt-get install --yes python3 python3-pip python3-gst-1.0 python3-gi python3-tz
+    apt-get install --yes alsa-utils mkvtoolnix
+    pip3 install saraswati --upgrade
 
 macOS systems
 -------------
@@ -100,10 +100,13 @@ Synchronize system time with NTP, this is important for appropriate timestamping
 Install Saraswati
 =================
 
-::
+Install ``saraswati`` package from PyPI::
 
     pip install saraswati
 
+To quickly verify the installation, invoke::
+
+    saraswati record --channel="testdrive source=autoaudiosrc"
 
 
 *****
diff --git a/doc/backlog.rst b/doc/backlog.rst
index 94cf130..5cf5936 100644
--- a/doc/backlog.rst
+++ b/doc/backlog.rst
@@ -6,5 +6,8 @@ Saraswati backlog
 - [x] Add command line interface
 - [o] Upload files and purge from local disk
 - [o] Record for a maximum number of settings, using GSt's ``num-buffers=``
-- [o] What about `muxer.audio_1`?
+- [o] What about ``muxer.audio_1``?
 - [o] Run as system daemon
+- [o] Realtime statistics
+- [o] Detect silence
+- [o] Use default chunk size of 5 minutes