Commit 60ec6848 authored by Dorota Czaplejewicz's avatar Dorota Czaplejewicz

readme: Moved to Markdown

parent b159625e
......@@ -19,6 +19,8 @@
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = eek eekboard src tests bindings docs po data examples
DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
AUTOMAKE_OPTIONS = foreign # allow README.md to exist
GITIGNOREFILES = \
INSTALL \
......
eekboard - an easy to use virtual keyboard toolkit -*- outline -*-
eekboard - an easy to use virtual keyboard toolkit
==================================================
eekboard is a virtual keyboard software package, including a set of
tools to implement desktop virtual keyboards.
* Building
Building
--------
** Dependencies
### Dependencies
REQUIRED: GLib2, GTK, PangoCairo, libxklavier, libcroco
OPTIONAL: libXtst, at-spi2-core, IBus, Clutter, Clutter-Gtk, Python, Vala, gobject-introspection, libcanberra
** Build from git repo
### Build from git repo
$ git clone git://github.com/ueno/eekboard.git
$ cd eekboard
$ ./autogen.sh --prefix=/usr --enable-gtk-doc
$ make
$ sudo make install
```
$ git clone git://github.com/ueno/eekboard.git
$ cd eekboard
$ ./autogen.sh --prefix=/usr --enable-gtk-doc
$ make
$ sudo make install
```
** Build from tarball
### Build from tarball
$ ./configure --prefix=/usr
$ make
$ sudo make install
```
$ ./configure --prefix=/usr
$ make
$ sudo make install
```
* Running
Running
-------
$ eekboard
$ eekboard -f # show/hide automatically based on focus-in/focus-out events
```
$ eekboard
$ eekboard -f # show/hide automatically based on focus-in/focus-out events
```
Even though eekboard -f watches a11y events by default, it currently
Even though `eekboard -f` watches a11y events by default, it currently
works better with IBus. To use IBus, do:
$ gsettings set org.fedorahosted.eekboard focus-listener 'ibus'
```
$ gsettings set org.fedorahosted.eekboard focus-listener 'ibus'
```
......@@ -7,7 +7,7 @@ test -z "$srcdir" && srcdir=.
PKG_NAME="eekboard"
(test -f $srcdir/configure.ac \
&& test -f $srcdir/README ) || {
&& test -f $srcdir/README.md ) || {
echo -n "**Error**: Directory "\`$srcdir\'" does not look like the"
echo " top-level $PKG_NAME directory"
exit 1
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment