summaryrefslogtreecommitdiffstats
path: root/network/periscope/README
diff options
context:
space:
mode:
Diffstat (limited to 'network/periscope/README')
-rw-r--r--network/periscope/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/network/periscope/README b/network/periscope/README
new file mode 100644
index 0000000000..dbe7af7b00
--- /dev/null
+++ b/network/periscope/README
@@ -0,0 +1,10 @@
+Periscope is a subtitles searching module written in python that tries to find
+a correct match for a given video file. The subtitles sites are handled as
+plugins and currently support OpenSubtitles, SubtitleSource, Podnapisi,
+Subscene and Subtitulos.
+
+A python/nautilus integration script is copied to the doc directory.
+
+The program requires pysetuptools for building and BeautifulSoup to run. A rar
+unpacker is recommended but can be avoided if you disable the plugins for
+subtitles sites using this format.