readme: Moved to Markdown
This commit is contained in:
@ -19,6 +19,8 @@
|
|||||||
ACLOCAL_AMFLAGS = -I m4
|
ACLOCAL_AMFLAGS = -I m4
|
||||||
SUBDIRS = eek eekboard src tests bindings docs po data examples
|
SUBDIRS = eek eekboard src tests bindings docs po data examples
|
||||||
DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
|
DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
|
||||||
|
AUTOMAKE_OPTIONS = foreign # allow README.md to exist
|
||||||
|
|
||||||
|
|
||||||
GITIGNOREFILES = \
|
GITIGNOREFILES = \
|
||||||
INSTALL \
|
INSTALL \
|
||||||
|
|||||||
35
README
35
README
@ -1,35 +0,0 @@
|
|||||||
eekboard - an easy to use virtual keyboard toolkit -*- outline -*-
|
|
||||||
|
|
||||||
eekboard is a virtual keyboard software package, including a set of
|
|
||||||
tools to implement desktop virtual keyboards.
|
|
||||||
|
|
||||||
* Building
|
|
||||||
|
|
||||||
** 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
|
|
||||||
|
|
||||||
$ git clone git://github.com/ueno/eekboard.git
|
|
||||||
$ cd eekboard
|
|
||||||
$ ./autogen.sh --prefix=/usr --enable-gtk-doc
|
|
||||||
$ make
|
|
||||||
$ sudo make install
|
|
||||||
|
|
||||||
** Build from tarball
|
|
||||||
|
|
||||||
$ ./configure --prefix=/usr
|
|
||||||
$ make
|
|
||||||
$ sudo make install
|
|
||||||
|
|
||||||
* Running
|
|
||||||
|
|
||||||
$ eekboard
|
|
||||||
$ eekboard -f # show/hide automatically based on focus-in/focus-out events
|
|
||||||
|
|
||||||
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'
|
|
||||||
46
README.md
Normal file
46
README.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
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
|
||||||
|
--------
|
||||||
|
|
||||||
|
### 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
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git clone git://github.com/ueno/eekboard.git
|
||||||
|
$ cd eekboard
|
||||||
|
$ ./autogen.sh --prefix=/usr --enable-gtk-doc
|
||||||
|
$ make
|
||||||
|
$ sudo make install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Build from tarball
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./configure --prefix=/usr
|
||||||
|
$ make
|
||||||
|
$ sudo make install
|
||||||
|
```
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
|
||||||
|
```
|
||||||
|
$ eekboard
|
||||||
|
$ eekboard -f # show/hide automatically based on focus-in/focus-out events
|
||||||
|
```
|
||||||
|
|
||||||
|
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'
|
||||||
|
```
|
||||||
@ -7,7 +7,7 @@ test -z "$srcdir" && srcdir=.
|
|||||||
PKG_NAME="eekboard"
|
PKG_NAME="eekboard"
|
||||||
|
|
||||||
(test -f $srcdir/configure.ac \
|
(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 -n "**Error**: Directory "\`$srcdir\'" does not look like the"
|
||||||
echo " top-level $PKG_NAME directory"
|
echo " top-level $PKG_NAME directory"
|
||||||
exit 1
|
exit 1
|
||||||
|
|||||||
Reference in New Issue
Block a user