diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7be95dd --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +## straw-viewer + +A lightweight application for searching and streaming videos from YouTube, using the API of [invidio.us](https://invidio.us/). + +### straw-viewer + +* command-line interface to YouTube. + + + +### gtk-straw-viewer + +* GTK+ interface to YouTube. + + + +### AVAILABILITY + +Under development. + +### INSTALLATION + +To install `straw-viewer`, run: + +```console + perl Build.PL + sudo ./Build installdeps + sudo ./Build install +``` + +To install `gtk-straw-viewer` along with `straw-viewer`, run: + +```console + perl Build.PL --gtk + sudo ./Build installdeps + sudo ./Build install +``` + +### DEPENDENCIES + +#### For straw-viewer: + +* [libwww-perl](https://metacpan.org/release/libwww-perl) +* [LWP::Protocol::https](https://metacpan.org/release/LWP-Protocol-https) +* [Data::Dump](https://metacpan.org/release/Data-Dump) +* [JSON](https://metacpan.org/release/JSON) + +#### For gtk-straw-viewer: + +* [Gtk3](https://metacpan.org/release/Gtk3) +* [File::ShareDir](https://metacpan.org/release/File-ShareDir) +* \+ the dependencies required by straw-viewer. + +#### Optional dependencies: + +* Local cache support: [LWP::UserAgent::Cached](https://metacpan.org/release/LWP-UserAgent-Cached) +* Better STDIN support (+ history): [Term::ReadLine::Gnu](https://metacpan.org/release/Term-ReadLine-Gnu) +* Faster JSON deserialization: [JSON::XS](https://metacpan.org/release/JSON-XS) +* Fixed-width formatting (--fixed-width, -W): [Unicode::LineBreak](https://metacpan.org/release/Unicode-LineBreak) or [Text::CharWidth](https://metacpan.org/release/Text-CharWidth) + + +### PACKAGING + +To package this application, run the following commands: + +```console + perl Build.PL --destdir "/my/package/path" --installdirs vendor [--gtk] + ./Build test + ./Build install --install_path script=/usr/bin +``` + +### SUPPORT AND DOCUMENTATION + +After installing, you can find documentation with the following commands: + + man straw-viewer + perldoc WWW::StrawViewer + +### LICENSE AND COPYRIGHT + +Copyright (C) 2012-2020 Trizen + +This program is free software; you can redistribute it and/or modify it +under the terms of either: the GNU General Public License as published +by the Free Software Foundation; or the Artistic License. + +See http://dev.perl.org/licenses/ for more information. |