summaryrefslogtreecommitdiff
path: root/multimedia/youtube-viewer/README
diff options
context:
space:
mode:
Diffstat (limited to 'multimedia/youtube-viewer/README')
-rw-r--r--multimedia/youtube-viewer/README25
1 files changed, 22 insertions, 3 deletions
diff --git a/multimedia/youtube-viewer/README b/multimedia/youtube-viewer/README
index 1b62324a7e..ac1d143ce4 100644
--- a/multimedia/youtube-viewer/README
+++ b/multimedia/youtube-viewer/README
@@ -1,3 +1,22 @@
-Youtube Viewer is a CLI application dedicated for searching and streaming
-Youtube Videos with MPlayer. It has been written in Perl and plays videos
-from Youtube at the best quality available without using a flash player.
+youtube-viewer (browse YouTube videos from a terminal or GTK UI)
+
+Youtube Viewer is a dedicated application for searching, viewing, and
+downloading Youtube videos, using wget for downloading and MPlayer for
+viewing. It has been written in Perl and plays videos from Youtube at
+the best quality available without using a flash player.
+
+Optional dependencies:
+
+perl-gtk2 and perl-File-ShareDir - for gtk-youtube-viewer.
+perl-LWP-Protocol-https - for https:// URL support.
+perl-Text-CharWidth - for better formatting in the terminal.
+
+This build always includes the command-line client (youtube-viewer). For
+the GTK client (gtk-youtube-viewer), install perl-gtk2 and
+perl-File-ShareDir before running this script. If you have them installed
+but don't want gtk-youtube-viewer, you can set GTK=no in the script's
+environment.
+
+To force gtk-youtube-viewer to use your preferred terminal for downloading
+with wget and watching in a terminal, set TERMINAL in the script's
+environment (e.g. TERMINAL="xterm" or TERMINAL="urxvt").