← Back to branch summary

~helene-verhaeghe27/cairo-dock-core/bugfix

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Matthieu Baerts
  • Date: 2012-08-13 18:19:10 UTC
  • Revision ID: matttbe@gmail.com-20120813181910-okbfrdn60okesqqt
INSTALL: updated the INSTALL file with some intructions to the packagers/maintainers

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
1
 
Basics :
2
 
--------
 
1
Basics:
 
2
-------
3
3
 
4
4
To compile the core or the plug-ins, just copy-paste these lines into a terminal (assuming you are in the main directory of the core/plug-ins) :
5
5
 
11
11
 
12
12
 
13
13
 
14
 
Notes :
15
 
-------
 
14
Notes:
 
15
------
16
16
 
17
17
Install the dock first, and then compile the plug-ins. For more details, have a look at this webpage: http://www.glx-dock.org/ww_page.php?p=By%20compiling&lang=en
18
18
 
36
36
Plug-ins are compiled all at once, but you can skip some of them. Unstable plug-ins are skipped by default, unless you add "-Denable-xxx=yes", where xxx is the name of the plug-in.
37
37
See the "Applets.stable" file in the "plug-ins" folder for an exhaustive list of stable applets (that are effectively integrated into the official package).
38
38
 
 
39
 
 
40
 
 
41
Notes to packagers/maintainers:
 
42
-------------------------------
 
43
 
 
44
You can use these CMake flags to install some files in other directories:
 
45
  CMAKE_INSTALL_BINDIR      (default: 'bin')
 
46
  CMAKE_INSTALL_LIBDIR      (default: 'lib' or 'lib64' on Debian 64bit distributions or forks)
 
47
  CMAKE_INSTALL_INCLUDEDIR  (default: 'include')
 
48
  CMAKE_INSTALL_DATAROOTDIR (default: 'share')
 
49
  CMAKE_INSTALL_DATADIR     (default: DATAROOTDIR)
 
50
  CMAKE_INSTALL_LOCALEDIR   (default: DATAROOTDIR'/locale')
 
51
  CMAKE_INSTALL_MANDIR      (default: DATAROOTDIR'/man')
 
52
 
 
53
Note that cairo-dock-plug-ins project needs the same version as the core.
 
54
We advice to create a few packages:
 
55
 * cairo-dock: a meta-package to install cairo-dock-core, cairo-dock-plug-ins, cairo-dock-plug-ins-integration and cairo-dock-plug-ins-dbus-interface-python
 
56
 * cairo-dock-core: with the binary (usr/bin)
 
57
 * cairo-dock-data: with common files (usr/share)
 
58
 * libgldiX: with the .so file (lib/libgldiX.so.*)
 
59
 * libgldi-dev: files needed to compile the plug-ins (usr/include, usr/lib/pkgconfig, usr/lib/libgldiX.so)
 
60
 * cairo-dock-plug-ins: with binaries files (usr/lib/cairo-dock/libcd-*.so)
 
61
 * cairo-dock-plug-ins-data: with common files (usr/share/locale, usr/share/cairo-dock, usr/lib/cairo-dock/*(!.so))
 
62
 * cairo-dock-plug-ins-integration: these files do NOT require any dependences, these plugins are automatically enabled if you're using gnome/kde/xfce. Note that it will try to use gvfs by default. (usr/lib/cairo-dock/libcd_*.so)
 
63
 * cairo-dock-plug-ins-dbus-interface-mono: with files of the mono interface (needed to launch 'third-party' applets made in Mono) (usr/lib/cli/cairo-dock-plug-ins/CDApplet*.dll)
 
64
 * cairo-dock-plug-ins-dbus-interface-python: with files of the Python interface (needed to launch 'third-party' applets made in Python) (usr/lib/python*/dist-packages/*.py)
 
65
 * cairo-dock-plug-ins-dbus-interface-ruby: with files of the Ruby interface (needed to launch 'third-party' applets made in Ruby) (usr/lib/ruby*)
 
66
 * cairo-dock-plug-ins-dbus-interface-vala: with files of the Vala interface (needed to launch 'third-party' applets made in Vala) (usr/lib/libCDApplet.so,usr/lib/pkgconfig/CDApplet.pc, usr/share/vala*)
 
67
 
 
68
About the Python interface, this CMake flag is needed to install files in another directory: -DROOT_PREFIX=/PATH/TO/YOUR/DIR
 
69
About the Cairo-Dock session, it uses gnome-session (>= 3.0) and this CMake flag is needed (for cairo-dock-core): -Denable-desktop-manager=yes
 
70
 
 
71
We are maintaining Ubuntu packages: https://launchpad.net/~cairo-dock-team/+archive/ppa/+packages
 
72
Feel free to have a look at the debian directory to have a few examples.
 
73
 
 
74
And don't hesitate to report any bugs and ideas and to propose patches ;)
 
75
 
 
76
 
 
77
If you like this project:
 
78
-------------------------
 
79
 
 
80
There are various ways to help us ;)
 
81
 http://glx-dock.org/ww_page.php?p=How%20to%20help%20us&lang=en
 
82
 
 
83
 
 
84
 
 
85
Notes to developers:
 
86
--------------------
 
87
 
 
88
This project is mostly coded in C but applets can be coded in various languages (Python, Ruby, Vala, Mono, Bash, etc.)
 
89
 
 
90
Please have a look at this webpage for more details: http://glx-dock.org/ww_page.php?p=Documentation&lang=en
 
91
 
39
92
To build the Cairo-Dock documentation, use the generate-doc.sh script in the 'doc' directory of the core.
40
93
 
 
94
 
 
95
 
 
96
 
41
97
Thanks for using Cairo-Dock, hope you will enjoy it ! ^_^
42
98
 
 
99
 
43
100
Website:        http://glx-dock.org/
44
101
Project:        https://launchpad.net/cairo-dock
45
102
Wiki:           http://wiki.glx-dock.org/
50
107
Applets extras: http://extras.glx-dock.org/
51
108
Identi.ca:      http://identi.ca/cairodock
52
109
Twitter:        http://twitter.com/cairodock
 
110
Google +:       https://plus.google.com/106693551620606700380/
 
111
Flattr:         https://flattr.com/thing/370779/Support-Cairo-Dock-development
 
112
Paypal & How to help us: http://glx-dock.org/ww_page.php?p=How%20to%20help%20us&lang=en