From 7055f5fa5057bbb404a249c826bcac90c3bd269f Mon Sep 17 00:00:00 2001 From: Daiki Ueno Date: Tue, 1 Feb 2011 11:01:16 +0900 Subject: [PATCH] Fix doc. --- README | 26 +++++++++++++++++++++----- TODO | 15 +-------------- 2 files changed, 22 insertions(+), 19 deletions(-) diff --git a/README b/README index 92ae4e30..3eb40eed 100644 --- a/README +++ b/README @@ -22,16 +22,32 @@ Build from git repo: $ ./configure $ make -How to test (dump/load the current layout): +Dump the current system layout to an XML file: $ ./tests/eek-example-xml -d > keyboard.xml + +Load and display a keyboard created from an XML file: + $ ./tests/eek-example-xml -l keyboard.xml -NOTE: eekboard is now being heavily rewritten and it may behave -wrongly. Make sure to close windows where you are doing any important -work, before running eekboard. +Start D-Bus server: $ ./src/eekboard-server & + +Access to the D-Bus server: + + $ ./src/eekboard-client --set-keyboard keyboard.xml + $ ./src/eekboard-client --show + $ ./src/eekboard-client --listen # press some keys on the keyboard + KeyPressed XXXXX + KeyReleased XXXXX + +Listen and follow the system events: + +NOTE: eekboard-system-client is now being heavily developed and it may +behave wrongly. Make sure to close windows where you are doing any +important work, before running eekboard. + $ ./src/eekboard-system-client --xklavier --accessibility --fakekey Where --xklavier is to monitor system keyboard layout change, @@ -41,4 +57,4 @@ key-press/key-release events. * Documentation - +See file:docs/reference/eek/html/index.html diff --git a/TODO b/TODO index 8c2ebf41..8b28faf0 100644 --- a/TODO +++ b/TODO @@ -1,14 +1 @@ -- packaging --- debian --- add more tests - -- eekboard --- rewrite in Vala - -- libeek --- CSS based themes --- Caribou layout engine (XML) --- matchbox-keyboard layout engine (XML) --- delay initialization of XKB and XKL layouts --- add mechanism to change appearances (colors?) of UI widgets - depending on modifier states +See https://github.com/ueno/eekboard/wiki/TODO