← Back to branch summary

~dhananjaysathe/nuvola-player/TelepathyExt

« back to all changes in this revision

Viewing changes to INSTALL

  • 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:
INSTALL
1
1
INSTALLATION OF NUVOLA PLAYER
2
2
 
3
 
See README.
4
 
 
5
 
--------------
6
 
TODO: make doc
 
3
 *   Report bugs at https://bugs.launchpad.net/nuvola-player
 
4
 *   Ask questions at https://answers.launchpad.net/nuvola-player
 
5
 *   Discuss at https://launchpad.net/~nuvola-player-devel
 
6
 
 
7
=== Dependencies ===
 
8
 
 
9
Bellow you can see a list of minimal and required  dependencies. Many of these
 
10
dependencies should be already available in an official repository of your
 
11
distribution, otherwise you can download them from their websites.
 
12
 
 
13
Nuvola Player has almost all features enabled by default, so you may have to disable
 
14
some of them if you cannot satisfy extra dependencies. The build script should
 
15
suggest you which features to turn off:
 
16
 
 
17
-----------8<---------
 
18
...
 
19
Configuration status                           : FAIL 
 
20
 
 
21
 * Unable to satisfy dependency glib-2.0 >= 2.26
 
22
 * Feature Dock Manager support requires gio-2.0 >= 2.26 and glib-2.0 >= 2.26.
 
23
   You can disable it by a flag --no-dock-manager.
 
24
 * Feature MPRIS support requires gio-2.0 >= 2.26 and glib-2.0 >= 2.26.
 
25
   You can disable it by a flag --no-mpris.
 
26
 * Feature console client requires gio-2.0 >= 2.26 and glib-2.0 >= 2.26.
 
27
   You can disable it by a flag --no-nuvola-client.
 
28
 * Feature support for media keys requires gio-2.0 >= 2.26 and glib-2.0 >= 2.26.
 
29
   You can disable it by a flag --no-media-keys.
 
30
...
 
31
-----------8<---------
 
32
 
 
33
Minimal dependencies:
 
34
 
 
35
  Programs (build time):
 
36
  
 
37
  gcc                            http://gcc.gnu.org/
 
38
  valac >= 0.12                  https://live.gnome.org/Vala
 
39
  python2 >= 2.5                 http://python.org/
 
40
  pkg-config                     http://www.freedesktop.org/wiki/Software/pkg-config
 
41
  msgfmt                         http://www.gnu.org/software/gettext/
 
42
  perl                           http://www.perl.org/
 
43
  intltool-merge                 http://ftp.gnome.org/pub/gnome/sources/intltool/
 
44
  rsvg-convert                   https://live.gnome.org/LibRsvg
 
45
  
 
46
  Programs (run time):
 
47
  
 
48
  xdg-utils                      http://portland.freedesktop.org/xdg-utils-1.0/
 
49
  
 
50
  Libraries (and their C header files in build time):
 
51
 
 
52
  gee-1.0 >=0.5                  https://live.gnome.org/Libgee/
 
53
  x11 >= 0.5                     http://www.x.org/wiki/
 
54
  gtk+-2.0 >= 2.20.0             http://www.gtk.org/
 
55
  gdk-2.0 >= 2.20.0              http://www.gtk.org/
 
56
  libsoup-2.4 >= 2.30            https://live.gnome.org/LibSoup
 
57
  unique-1.0 >= 0.9              https://live.gnome.org/LibUnique/
 
58
  webkit-1.0 >= 1.0, < 1.7       http://webkitgtk.org/
 
59
  glib-2.0 >= 2.22               http://www.gtk.org/
 
60
  gio-2.0 >= 2.22                http://www.gtk.org/
 
61
  libdl                          (core library)
 
62
 
 
63
Extra dependencies:
 
64
 
 
65
  Programs (build time):
 
66
    
 
67
  scour                          http://codedread.com/scour/
 
68
  
 
69
  Programs (run time):
 
70
    
 
71
  tsocks                         http://tsocks.sourceforge.net/
 
72
    
 
73
  Libraries (and their C header files in build time):
 
74
 
 
75
  gee-1.0 >= 0.6                 https://live.gnome.org/Libgee/
 
76
  libnotify >= 0.4               http://ftp.gnome.org/pub/GNOME/sources/libnotify/
 
77
  libsoup-2.4 >= 2.34            https://live.gnome.org/LibSoup
 
78
  json-glib-1.0 >= 0.7           https://live.gnome.org/JsonGlib/
 
79
  unity >= 3.0                   https://launchpad.net/libunity
 
80
  dbusmenu-glib-0.4 >= 0.4       https://launchpad.net/dbusmenu
 
81
  webkit-1.0 >= 1.5, < 1.7       http://webkitgtk.org/
 
82
  javascriptcoregtk-1.0 >= 1.5   http://webkitgtk.org/
 
83
  glib-2.0 >= 2.26               http://www.gtk.org/
 
84
  gio-2.0 >= 2.26                http://www.gtk.org/
 
85
 
 
86
=== Configure build process ===
 
87
 
 
88
Run command `python2 ./waf configure [OPTIONS]` to configure the build process.
 
89
 
 
90
You may also want
 
91
 
 
92
 *  to change installation prefix:
 
93
 
 
94
        `python2 ./waf configure --prefix=/usr`
 
95
 
 
96
 *  to disable some features if you cannot satisfy some extra dependencies:
 
97
 
 
98
        `python2 ./waf configure --no-unity-quick-list`
 
99
 
 
100
 *  to read build script help:
 
101
 
 
102
        `python2 ./waf --help`
 
103
 
 
104
=== Trigger the build process ===
 
105
 
 
106
Run command `python2 ./waf build` to build Nuvola Player
 
107
 
 
108
=== Trigger installation ===
 
109
 
 
110
Run command `python2 ./waf install` as root to install Nuvola Player.
 
111
 
 
112
=== Stable vs Unstable builds ===
 
113
 
 
114
Stable build are build without debug symbols by default:
 
115
        
 
116
  $ ./waf configure --no-debug-symbols build && ls -l build/nuvola*
 
117
  ...
 
118
  'build' finished successfully (0.035s)
 
119
  -rwxrwxr-x 1 fenryxo fenryxo 645083 2012-07-01 18:58 build/nuvolaplayer*
 
120
  -rwxrwxr-x 1 fenryxo fenryxo  44010 2012-07-01 18:58 build/nuvolaplayer-client*
 
121
  
 
122
Unstable builds contains debugging symbols by default, so they can have bigger
 
123
memory usage and may run slower:
 
124
  
 
125
  $ ./waf configure --debug-symbols build && ls -l build/nuvola*
 
126
  ...
 
127
  'build' finished successfully (5.998s)
 
128
  -rwxrwxr-x 1 fenryxo fenryxo 15150710 2012-07-01 19:03 build/nuvolaplayer
 
129
  -rwxrwxr-x 1 fenryxo fenryxo   297170 2012-07-01 19:02 build/nuvolaplayer-client
 
130
 
 
131
=== Clean build environment ===
 
132
 
 
133
When the build fails, try to clean the build environment:
 
134
 
 
135
$ python2 ./waf distclean configure build