DeforaOS/Keyboard
DeforaOS/Keyboard
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Extend the README file

Browse Source
This commit is contained in:
Pierre Pronchery 2020-01-12 07:43:14 +01:00
parent bb15f6d342
commit 7acf53d551
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -8,11 +8,13 @@ This program emulates a physical keyboard by providing a virtual interface on
screen. It currently supports four modes: screen. It currently supports four modes:
* docked, where it will occupy the bottom of the screen; * docked, where it will occupy the bottom of the screen;
* popup, likewise as a popup window; * popup, likewise as a popup window;
* windowed, where it can be found in the system tray (default) * windowed, where it can be found in the system tray (the default)
* embedded, which outputs its window ID for inclusion within another program. * embedded, which outputs its window ID for inclusion within another program.
Additionally, it can be piloted through its companion tool, `desktopctl(1)`. Additionally, it can be piloted through its companion tool, `desktopctl(1)`.
Keyboard is part of the DeforaOS Project, found at https://www.defora.org/.
Compiling Keyboard Compiling Keyboard
------------------ ------------------
@ -27,6 +29,20 @@ on most systems:
$ make $ make
The following command will then install Keyboard:
$ make install
To install (or package) Keyboard in a different location:
$ make clean
$ make PREFIX="/another/prefix" install
Keyboard also supports `DESTDIR`, to be installed in a staging directory; for
instance:
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
On some systems, the Makefiles shipped can be re-generated accordingly thanks to On some systems, the Makefiles shipped can be re-generated accordingly thanks to
the DeforaOS configure tool. the DeforaOS configure tool.