Skip to content

Commit fb9ad81

Browse files
authored
Merge pull request #69 from KAMiKAZOW/patch-4
Update and rename README to README.md
2 parents 60f33b0 + 7d5dbf2 commit fb9ad81

1 file changed

Lines changed: 18 additions & 11 deletions

File tree

README renamed to README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,51 @@
11
Maliit
2+
======
23

34
Maliit provides a flexible and cross-platform input method framework. It has a
45
plugin-based client-server architecture where applications act as clients and
56
communicate with the Maliit server via input context plugins. The communication
6-
link currently uses D-Bus. Maliit is an open source framework (LGPL 2) with
7-
open source plugins (BSD).
8-
9-
This is the Maliit framework. For a virtual keyboard, see
10-
https://github.com/maliit/keyboard .
11-
7+
link currently uses D-Bus. Maliit is an open source framework (LGPL 2.1) with
8+
a production-quality [keyboard plugin](https://github.com/maliit/keyboard) (LGPL 3.0).
129

1310
Installing
11+
----------
1412

15-
Qt5 must be installed to build the Maliit framework. At a terminal, run:
13+
Qt 5 must be installed to build the Maliit framework. At a terminal, run:
1614

15+
```
1716
mkdir build
1817
cd build
1918
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
2019
make
2120
make install
22-
23-
Run qmake HELP=1 to get more information about build options.
24-
21+
```
2522

2623
Running
24+
-------
2725

2826
Set Maliit as the Qt and GTK+ input context:
2927

28+
```
3029
export QT_IM_MODULE=Maliit
3130
export GTK_IM_MODULE=Maliit
31+
```
3232

3333
Start the server:
3434

35+
```
3536
maliit-server
37+
```
3638

3739
Note that a compositing window manager and a D-Bus session bus are required to
3840
use Maliit.
3941

4042
Test with the provided example applications:
4143

44+
```
4245
maliit-exampleapp-plainqt # for Qt
4346
maliit-exampleapp-gtk2 # for Gtk2
4447
maliit-exampleapp-gtk3 # for Gtk3
48+
```
4549

4650
Double-tap on the input field, and an input method (usually a virtual keyboard)
4751
should be shown. Note that an input method plugin, such as the Maliit keyboard
@@ -52,17 +56,20 @@ to work.
5256
NETWORK TRANSPARENCY
5357

5458
On one computer run:
59+
```
5560
maliit-server -allow-anonymous -override-address tcp:host=xxx.xxx.xxx.xxx,port=yyyyy
61+
```
5662

5763
Any valid dbus address is supported. Using -allow-anonymous must only be done on
5864
a trusted network. If using a method with authentication, the -allow-anonymous flag
5965
may be dropped.
6066

6167
On another computer:
68+
```
6269
MALIIT_SERVER_ADDRESS=tcp:host=xxx.xxx.xxx.xxx,port=yyyyy
6370
export MALIIT_SERVER_ADDRESS
6471
maliit-exampleapp-plainqt (or maliit-exampleapp-gtk{2,3})
72+
```
6573

6674
Where xxx.xxx.xxx.xxx is IP address of computer where maliit-server is ran
6775
and yyyyy is port number < 65536.
68-

0 commit comments

Comments
 (0)