Add my changes in the README
[indicator-chars.git] / README.rst
1 ===============
2 indicator-chars
3 ===============
4
5 :Author: Tobias Schlitt <toby@php.net>
6
7 App indicator to provide a menu with (potentially funny UTF-8) characters for
8 simple copying them to clipboard (similar to original characters applet).
9
10 Create a file .indicator-chars in your home directory with lines of
11 characters to be selectable.
12
13 -------
14 Fork Cyrille37
15 -------
16
17 :Author: Cyrille37 <cyrille37@gmail.com>
18
19 Some changes to make indicator-chars works on Ubuntu 12.04LTS with Unity 2D
20 - replace the custom icon with a theme icon name
21 - add a char copy into Clipboard(selection="CLIPBOARD")
22 Other minors changes
23 - use env to find the Python engine
24 - add a configuration file example: "conf-example.indicator-chars"
25
26 -------
27 Install
28 -------
29
30 - Checkout source code
31
32 - Create ~/.indicator-chars
33
34   - Each row corresponds to a set of chars
35
36   - Optional submenu title prefix: "[title]" (trailing spaces stripped)
37
38   - Optional descriptions after chars: "(description)" (leading &
39     trailing spaces stripped)
40
41   - Spaces (apart from above) also count as chars
42
43   - Make sure to use UTF-8 encoding
44
45 - Put indicator-chars.py into auto start
46
47 -----------
48 Open issues
49 -----------
50
51 - If anyone could design a nice, unity style indicator icon?
52
53 - Maybe there is a way to use multiple click buttons in menu items?
54
55   - No standard Gtk way does not work.