README - colibri in Colibri

# What is it?

Colibri provides an alternative to KDE4 Plasma notifications.

Colibri notifications look lighter and are completely passive: they do not
provide any buttons. You may or may not like this.

Since they are completely passive, they smoothly fade away when you mouse over
them, allowing you to interact with any window behind them.

They also do not stack each others: if multiple notifications happen, they will
be shown one at a time.

Colibri is licensed under the GNU GPLv2 or later.

# Building it

You need kdelibs >= 4.4.

Build it with:

    mkdir build
    cd build
    cmake -DCMAKE_INSTALL_PREFIX=/usr <path/to/colibri/sources>
    make
    sudo make install

You may need to replace /usr with the path to your KDE installation.

# Enabling Colibri notifications

Enabling Colibri notifications can be a bit tricky.

First you need to open Colibri module in "System Settings":
- Start "System Settings"
- Open the "System and Application Notifications" category
- Select "Colibri Notifications"

## Another notification system is running

If there is an error bar telling you to stop an existing notification system,
here is how to do it, depending on the current notification system.

If the system is "notify-osd" or "notification-daemon", just stop them with
"killall notify-osd" or "killall notification-daemon".

If the system is "Plasma", you must disable notification handling in Plasma.

To do so on KDE 4.4:
- Right-click on the systemtray applet
- Select "System Tray Settings"
- Uncheck the "Application notifications" box

To do so on KDE 4.5:
- Right-click on the (i) icon in the systemtray applet
- Select "Notification Settings"
- Unckeck the "Application notifications" box

## No notification system is running

Just click the "Start Colibri" button.

## Testing it

Click the "Preview" button, you should see a notification appear in the
selected corner.

# A bit of history

Passive notifications for Plasma first appeared as "Ayatana notifications", an
alternative notification system I implemented in Kubuntu Karmic as part of my
work for Canonical.

Ayatana notifications were implemented as a patch against the systemtray
applet. Colibri is based on this work, but does not require patching any
applet.

Colibri contains code I wrote for Canonical, but it is not a Canonical product.

# Contact
Email: Aurélien Gâteau <agateau@kde.org>
To report bugs: http://bugs.kde.org

1	# What is it?
2
3	Colibri provides an alternative to KDE4 Plasma notifications.
4
5	Colibri notifications look lighter and are completely passive: they do not
6	provide any buttons. You may or may not like this.
7
8	Since they are completely passive, they smoothly fade away when you mouse over
9	them, allowing you to interact with any window behind them.
10
11	They also do not stack each others: if multiple notifications happen, they will
12	be shown one at a time.
13
14	Colibri is licensed under the GNU GPLv2 or later.
15
16	# Building it
17
18	You need kdelibs >= 4.4.
19
20	Build it with:
21
22	mkdir build
23	cd build
24	cmake -DCMAKE_INSTALL_PREFIX=/usr <path/to/colibri/sources>
25	make
26	sudo make install
27
28	You may need to replace /usr with the path to your KDE installation.
29
30	# Enabling Colibri notifications
31
32	Enabling Colibri notifications can be a bit tricky.
33
34	First you need to open Colibri module in "System Settings":
35	- Start "System Settings"
36	- Open the "System and Application Notifications" category
37	- Select "Colibri Notifications"
38
39	## Another notification system is running
40
41	If there is an error bar telling you to stop an existing notification system,
42	here is how to do it, depending on the current notification system.
43
44	If the system is "notify-osd" or "notification-daemon", just stop them with
45	"killall notify-osd" or "killall notification-daemon".
46
47	If the system is "Plasma", you must disable notification handling in Plasma.
48
49	To do so on KDE 4.4:
50	- Right-click on the systemtray applet
51	- Select "System Tray Settings"
52	- Uncheck the "Application notifications" box
53
54	To do so on KDE 4.5:
55	- Right-click on the (i) icon in the systemtray applet
56	- Select "Notification Settings"
57	- Unckeck the "Application notifications" box
58
59	## No notification system is running
60
61	Just click the "Start Colibri" button.
62
63	## Testing it
64
65	Click the "Preview" button, you should see a notification appear in the
66	selected corner.
67
68	# A bit of history
69
70	Passive notifications for Plasma first appeared as "Ayatana notifications", an
71	alternative notification system I implemented in Kubuntu Karmic as part of my
72	work for Canonical.
73
74	Ayatana notifications were implemented as a patch against the systemtray
75	applet. Colibri is based on this work, but does not require patching any
76	applet.
77
78	Colibri contains code I wrote for Canonical, but it is not a Canonical product.
79
80	# Contact
81	Email: Aurélien Gâteau <agateau@kde.org>
82	To report bugs: http://bugs.kde.org

Gitorious