aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Christopher Rosell <chrippa@tanuki.se>2012-06-18 19:36:40 +0200
committerGravatar Christopher Rosell <chrippa@tanuki.se>2012-06-18 19:36:40 +0200
commitf2a27e8456bd40a17a8fd1c249b6fcdf9a0476b4 (patch)
tree0b2306699c320b7a741c5b632a116a4037db4846
parentecb020250d89b6a25b9b6b4fadb33b585994e094 (diff)
Update README with Windows instructions.
-rw-r--r--README.md58
1 files changed, 31 insertions, 27 deletions
diff --git a/README.md b/README.md
index c2b2f8d..82a9595 100644
--- a/README.md
+++ b/README.md
@@ -3,30 +3,47 @@ Livestreamer
Livestreamer is a CLI program that launches streams from various
streaming services in a custom video player.
+Currently supported sites are:
+
+* Justin.tv/Twitch.tv
+* Own3d.tv
+* SVTPlay
+* UStream
+* YouTube
+
+Note: Justin.tv plugin requires rtmpdump with jtv token support (recent git).
-Installing
-----------
- $ sudo python setup.py install
Livestreamer is compatible with Python version >= 2.6 and >= 3.0.
-Using
------
- $ livestreamer --help
+Installing (Linux, OS X etc)
+----------
+Make sure you have Python and Python setuptools then run:
+
+ $ sudo python setup.py install
-Example usage
--------------
-Find out what stream qualities are available
+Installing (Windows)
+--------------------
+1. Install Python
+2. Install Python setuptools
+3. Get rtmpdump and unpack it somewhere (rtmpdump-20110925-git-6230845-win32.zip from http://rtmpdump.mplayerhq.hu/ should work)
+4. Add these paths to your Path environment variable:
+ * [Python path]\
+ * [Python path]\scripts\
+ * [rtmpdump path]\ (or specify full path with --rtmpdump option)
+ * [VLC/mplayer/other path]\ (or specify full path with --player option)
- $ livestreamer http://www.twitch.tv/ignproleague
- Found streams: 240p, 360p, 480p, 720p, iphonehigh, iphonelow, live
+5. Open a command prompt and change directory to livestreamer source, then run:
+ python setup.py install
-Now play one of them
+Note: If you want to use VLC be aware there is currently a bug in version 2.0.1
+that prevents stdin reading from working. Use 2.0.0 or a nightly build for now.
- $ livestreamer http://www.twitch.tv/ignproleague 720p
-Stream now playbacks in default player (VLC).
+Using
+-----
+ $ livestreamer --help
Saving arguments AKA config file
@@ -38,19 +55,6 @@ A example file:
jtv-cookie=_jtv3_session_id=arandomhash
-Notes
------
-Currently supported sites are:
-
-* Justin.tv/Twitch.tv
-* Own3D.tv
-* SVTPlay
-* UStream
-* YouTube
-
-Justin.tv plugin requires rtmpdump with jtv token support (recent git).
-
-
Using livestreamer as a library
-------------------------------
Livestreamer is also a library. Short example: