1 files changed, 38 insertions, 0 deletions
diff --git a/multimedia/straw-viewer/README b/multimedia/straw-viewer/README
new file mode 100644
index 0000000000000..3ad09abd81cf7
--- /dev/null
+++ b/multimedia/straw-viewer/README
@@ -0,0 +1,38 @@
+straw-viewer (search and stream videos from youtube)
+
+straw-viewer is a lightweight application for searching and streaming
+videos from YouTube, using the API of invidio.us. The project is in its
+early development stages and some features are not implemented yet.
+
+straw-viewer is a fork of youtube-viewer that does not require a Google
+API key. Usage and user interface are identical to youtube-viewer.
+
+Optional dependencies:
+
+perl-Gtk3, perl-File-ShareDir - for gtk-straw-viewer.
+perl-lwp-useragent-cached - for local cache support.
+perl-JSON-XS - for faster JSON deserialization.
+perl-Text-CharWidth, perl-Unicode-LineBreak - for better formatting
+                                              in the terminal.
+perl-Term-ReadLine-Gnu - for command editing/history in the terminal.
+youtube-dl [1] - if this is present, straw-viewer will use it to detect
+                 available formats for the video.
+
+Counting optional ones, straw-viewer has over 40 dependencies. To make
+life easier, there's a "straw-viewer.sqf" queue file included with this
+build, which includes everything listed above.
+
+[1] A small caveat about youtube-dl: straw-viewer works without it,
+though occasionally it'll choose a lower quality than is available
+for some videos. However, if youtube-dl is present but outdated,
+straw-viewer will fail to play videos at all! If you suspect this,
+remove youtube-dl and try without it.
+
+This build always includes the command-line client (straw-viewer). For the
+GTK client (gtk-straw-viewer), install perl-Gtk3 and perl-File-ShareDir
+before running this script. If you have them installed but don't want
+gtk-straw-viewer, you can set GTK=no in the script's environment.
+
+To force gtk-straw-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").