instrumentation: add next-share/
[cs-p2p-next.git] / instrumentation / next-share / README.txt
1 \r
2 ==============================================================================\r
3                              Next-Share: \r
4       The next generation Peer-to-Peer content delivery platform\r
5     \r
6                        http://www.p2p-next.org/\r
7 ==============================================================================\r
8 \r
9 LICENSE\r
10 -------\r
11 See LICENSE.txt and binary-LICENSE.txt.\r
12 \r
13 \r
14 PREREQUISITES\r
15 -------------\r
16 \r
17 To run the Next-Share platform from source you will need to install the\r
18 following software packages. See www.p2p-next.org for binary distributions.\r
19 \r
20    Python >= 2.5\r
21    M2Crypto >= 0.16\r
22    wxPython >= 2.8 UNICODE (i.e., use --enable-unicode to build)\r
23    APSW aka. python-apsw >= 3.6.x (Python wrappers for SQLite database)\r
24    pywin32 >= Build 208 (Windows only, for e.g. UPnP support)\r
25    vlc:\r
26         For SwarmPlayer V1: VLC >= 1.0.5 with its Python bindings\r
27         For SwarmPlugin: VLC >= 1.0.5 with P2P-Next extension\r
28    simplejson >= 2.1.1 (if Python < 2.6)\r
29    xulrunner-sdk >= 1.9.1.5 < 1.9.2 (optional, to run SwarmPlayer V2/SwarmTransport)\r
30    7-Zip >= 4.6.5 (optional, to build SwarmPlayer V2/SwarmTransport)\r
31 \r
32 Next-Share runs on Windows (XP,Vista), Mac OS X and Linux. On Linux, it is \r
33 easiest to try to install these packages via a package manager such as\r
34 Synaptic (on Ubuntu). To run from the source on Windows it is easiest to use\r
35 binary distribution of all packages. On Mac, we advice to use MacPorts.\r
36 \r
37 INSTALLING ON LINUX\r
38 -------------------\r
39  \r
40 1. Unpack the main source code.\r
41 \r
42 2. Change to the Next-Share directory.\r
43 \r
44 2. The peer-to-peer video player SwarmPlayer that is part of Next-Share can now\r
45    be started by running\r
46 \r
47      PYTHONPATH="$PYTHONPATH":Next-Share:.\r
48      export PYTHONPATH\r
49      python2.5 BaseLib/Player/swarmplayer.py\r
50   \r
51 \r
52 INSTALLING ON WINDOWS\r
53 ---------------------\r
54 \r
55 1. Unpack the main source code.\r
56 \r
57 2. Open an CMD Prompt, change to the Next-Share directory.\r
58    \r
59 3. The peer-to-peer video player SwarmPlayer that is part of Next-Share can now\r
60    be started by running\r
61 \r
62      set PYTHONPATH=%PYTHONPATH%:Next-Share:.\r
63      C:\Python25\python2.5.exe BaseLib\Player\swarmplayer.py\r
64    \r
65 To build the SwarmPlugin, i.e., the browser plugin for P2P-based video\r
66 delivery and playback, or the SwarmPlayer V2 aka SwarmTransport, i.e., the\r
67 browser extension that adds P2P-based delivery as a new tribe:// transport\r
68 protocol, see the instructions in the D6.5.4 deliverable in the Publications\r
69 section of www.p2p-next.org.\r
70 \r
71 Arno Bakker, 2010-08-16\r