Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Jun 20, 2021
1 parent d53193c commit a0a74fd
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CHANGES.rst
Expand Up @@ -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
================
Expand Down
19 changes: 11 additions & 8 deletions README.rst
Expand Up @@ -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.
Expand All @@ -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
-------------
Expand All @@ -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"


*****
Expand Down
5 changes: 4 additions & 1 deletion doc/backlog.rst
Expand Up @@ -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

0 comments on commit a0a74fd

Please sign in to comment.