Go to file

Pierre Pronchery 47cd7628bd Build with Gtk+ 3 by default		2020-01-12 03:31:03 +01:00
data	No longer store Makefiles in the source tree	2015-04-05 19:31:06 +02:00
include	Update the copyright notice	2016-09-24 04:16:04 +02:00
po	Update the translations	2016-09-24 04:24:41 +02:00
src	Stick to the default stack protector	2017-07-26 15:30:52 +02:00
tools	Build with Gtk+ 3 by default	2020-01-12 03:31:03 +01:00
.gitignore	Also ignore shared objects	2016-03-12 02:27:59 +01:00
COPYING	Re-license as 2-clause BSD	2016-09-24 04:15:43 +02:00
project.conf	About to release DeforaOS Keyboard 0.3.1	2016-09-24 04:25:26 +02:00
README.md	Add and install a README file	2016-09-24 04:16:22 +02:00

README.md

DeforaOS Keyboard

About Keyboard

This program emulates a physical keyboard by providing a virtual interface on screen. It currently supports four modes:

docked, where it will occupy the bottom of the screen;
popup, likewise as a popup window;
windowed, where it can be found in the system tray (default)
embedded, which outputs its window ID for inclusion within another program.

Additionally, it can be piloted through its companion tool, desktopctl(1).

Compiling Keyboard

The current requirements for compiling Keyboard are as follows:

Gtk+ 2.4 or later, or Gtk+ 3.0 or later
DeforaOS libDesktop
an implementation of make
gettext (libintl) for translations

With these installed, the following command should be enough to compile Keyboard on most systems:

$ make

On some systems, the Makefiles shipped can be re-generated accordingly thanks to the DeforaOS configure tool.

The compilation process supports a number of options, such as PREFIX and DESTDIR for packaging and portability, or OBJDIR for compilation outside of the source tree.

Distributing Keyboard

DeforaOS Keyboard is subject to the terms of the 2-clause BSD license. Please see the COPYING file for more information.