Skip to content

Commit

Permalink
More usage info
Browse files Browse the repository at this point in the history
  • Loading branch information
wsanchez committed Nov 8, 2023
1 parent 22fd3c2 commit 9d49525
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,38 @@ Usage

``rtx`` provides a command line application that lets you browse though indexed audio content.
If you have an existing data file containing an index, put that at ``~/rtx.sqlite``.
Then start the application:
Then start the interactive application:

.. code-block:: console
rtx application
If you simply want a report of the indexed content, you can get that directly:

.. code-block:: console
# All transmissions
rtx transmissions
# Search
rtx transmissions --search="ranger"
To generate your an index of audio files (warning: this takes a very long time), first create a file ``~/.rtx.toml`` which describes where to find the audio content:

.. code-block:: console
[Audio.Event.2023]
Name = "Burning Man 2023"
SourceDirectory = "~/Google Drive/Shared drives/2023 Radio System Archive"
Then run the indexer:

.. code-block:: console
rtx index
.. _Homebrew: https://brew.sh
.. _ffmpeg: https://ffmpeg.org
Expand Down

0 comments on commit 9d49525

Please sign in to comment.