← Back to branch summary

~dhananjaysathe/nuvola-player/TelepathyExt

« back to all changes in this revision

Viewing changes to README

  • Committer: Jiří Janoušek
  • Date: 2012-07-14 21:23:34 UTC
  • Revision ID: janousek.jiri@gmail.com-20120714212334-4oow3eufqbw0rdme
Build script refactoring with a breakage.

 * More `./waf configure` options, type `./waf --help`
   or `./waf features` for details.
 * All fetures are enabled by default, some of them can
   be disabled if it is not possible to satisfy all
   dependencies. See INSTALL.
 * Removed README.Ubuntu and README.Fedora.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
===== INFORMATION ABOUT NUVOLA PLAYER =====
2
 
 
3
 
    See also README.Ubuntu and README.Fedora for Ubuntu/Fedora specific information
4
 
 
5
 
Nuvola Player runs web interface of cloud music service in its own window and provides
6
 
integration with a Linux desktop (system tray, Ubuntu sound menu, dock menu
7
 
and notifications). Currently supported services are Google Music, Grooveshark,
8
 
Hype Machine and 8tracks.
9
 
 
10
 
====== COPYRIGHT ======
11
 
 
12
 
Copyright 2011 Jiří Janoušek <janousek.jiri@gmail.com>
13
 
 
14
 
This program is free software: you can redistribute it and/or modify it 
15
 
under the terms of the GNU General Public License version 3, as published 
16
 
by the Free Software Foundation.
17
 
 
18
 
This program is distributed in the hope that it will be useful, but 
19
 
WITHOUT ANY WARRANTY; without even the implied warranties of 
20
 
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
21
 
PURPOSE.  See the GNU General Public License for more details.
22
 
 
23
 
You should have received a copy of the GNU General Public License along 
24
 
with this program.  If not, see <http://www.gnu.org/licenses/>.
25
 
 
26
 
====== INSTALLATION FROM SOURCE ======
27
 
    
28
 
    See also README.Ubuntu and README.Fedora for Ubuntu/Fedora specific information
29
 
    
30
 
1) Get the source code
31
 
 
32
 
Source code can be obtained from Bazaar repository at Launchpad.net. Supposing Bazaar
33
 
version control system <http://bazaar.canonical.com/> is installed following command
34
 
obtains a fresh copy of the main development branch.
35
 
    
36
 
    bzr branch lp:nuvola-player
37
 
 
38
 
You can also download beta and stable snapshots
39
 
 
40
 
    bzr branch lp:nuvola-player/releases-1.x
41
 
 
42
 
2) Install build dependencies
43
 
 
44
 
Make sure following build depencencies are satisfied (package names can differ in your
45
 
distribution):
46
 
 
47
 
    libglib (>= 2.26), libgee (>= 0.5), libsoup (>= 2.30),
48
 
    libgtk (>= 2.20), libwebkitgtk (>= 1.2), python (>= 2.6), valac (>= 0.12),
49
 
    libnotify (>= 0.4), libx11, libunique (>= 0.9), intltool, librsvg-bin,
50
 
    json-glib-1.0 (>= 0.7)
51
 
 
52
 
    
53
 
There are some optional dependencies:
54
 
    libsoup >= 2.34
55
 
        enables browser cache for remote objects (images, etc.)
56
 
    
57
 
    libunity, libdbusmenu-glib
58
 
        enables integration with Unity Quick List
59
 
    
60
 
    python-scour
61
 
        enables optimization of SVG icon (reduced size)
62
 
 
63
 
3) Clean the build environment
64
 
 
65
 
Cached results of the previous unsuccesfull configure/build processes may cause problems
66
 
in the next builds. Use `./waf distclean` to clean the build environment.
67
 
 
68
 
4) Configure build process
69
 
 
70
 
Nuvola Player uses Waf build system <http://code.google.com/p/waf/>. Source
71
 
distribution should already contain standalone version of Waf. To trigger configure
72
 
process, run command `./waf configure`. There are a few configuration options:
73
 
 
74
 
    --without-glib-dbus
75
 
        Allows building with GLib < 2.26, but without following fratures:
76
 
            * multimedia keys
77
 
            * dock manager integration (Docky)
78
 
            * MPRIS (interface to control playback from applets and other applications)
79
 
 
80
 
    --debug-symbols
81
 
    --no-debug-symbols
82
 
        Controls embedding of debugging symbols and compiler optimization. Stable build are build
83
 
        without debug symbols by default:
84
 
        
85
 
        $ ./waf configure --no-debug-symbols build && ls -l build/nuvola*
86
 
        ...
87
 
        'build' finished successfully (0.035s)
88
 
        -rwxrwxr-x 1 fenryxo fenryxo 645083 2012-07-01 18:58 build/nuvolaplayer*
89
 
        -rwxrwxr-x 1 fenryxo fenryxo  44010 2012-07-01 18:58 build/nuvolaplayer-client*
90
 
        
91
 
        However, unstable builds contains debugging symbols by default, so they can have bigger
92
 
        memory usage and may run slower:
93
 
        
94
 
        $ ./waf configure --debug-symbols build && ls -l build/nuvola*
95
 
        'build' finished successfully (5.998s)
96
 
        -rwxrwxr-x 1 fenryxo fenryxo 15150710 2012-07-01 19:03 build/nuvolaplayer
97
 
        -rwxrwxr-x 1 fenryxo fenryxo   297170 2012-07-01 19:02 build/nuvolaplayer-client
98
 
        
99
 
        
100
 
                
101
 
 
102
 
5) Compilation process
103
 
 
104
 
To trigger compilation process, run command `./waf build`.
105
 
    
106
 
6) Installation of GMF
107
 
 
108
 
To install GMF run:
109
 
    
110
 
    # ./waf install
111
 
 
112
 
7) Flash installation
113
 
 
114
 
Make sure Adobe Flash is installed. See your distribution documentation for details
115
 
about installing Adobe Flash.
116
 
 
117
 
8) Run-time dependencies
118
 
 
119
 
Before running GMF make sure run-time dependencies are satisfied (package names can differ
120
 
in your distribution):
121
 
 
122
 
    libatk (>= 1.29.3), libc6 (>= 2.3.6-6~), libcairo2 (>= 1.2.4),
123
 
    libdbus (>= 1.0.2), libdbus-glib (>= 0.78), libfontconfig (>= 2.8.0),
124
 
    libfreetype6 (>= 2.2.1), libgee2, libglib2 (>= 2.24), libgtk2 (>= 2.20),
125
 
    libnotify1 (>= 0.4.5), libnotify1-gtk2, libpango (>= 1.14.0),
126
 
    libsoup2.4 (>= 2.30), libunique-1.0 (>= 1.0.0), libwebkitgtk (>= 1.1.5),
127
 
    libx11, xdg-utils
128
 
 
129
 
Optional run-time dependency is tsocks library to provide support of SOCKS proxies
130
 
 
131
 
9) Run Nuvola Player
132
 
    
133
 
    $ nuvola-player
 
1
===== ABOUT NUVOLA PLAYER =====
 
2
 
 
3
Nuvola Player runs a web interface of cloud music services in its own window
 
4
and provides integration with a Linux desktop (multimedia keys, system tray,
 
5
media player applets, dock menu, notifications and more).
 
6
 
 
7
More information at http://nuvolaplayer.fenryxo.cz/
 
8
 
 
9
=== Adobe Flash ===
 
10
 
 
11
Some service use HTML5 features for playback and do not need Adobe Flash Plugin.
 
12
The HTML5 based interface may not be enabled by default, in that case please see
 
13
documentation of your streaming service how to turn it on.
 
14
 
 
15
Some services may require Adobe Flash plugin for music playback. In that case,
 
16
please see your distribution documentation for details about installation
 
17
of Adobe Flash. 
 
18
 
 
19
=== Installation and dependencies ===
 
20
 
 
21
See file INSTALL.