IBusFactory: Fix syntax of gtk-doc comment

[platform/upstream/ibus.git] / README

diff --git a/README b/README
index bd6be46..01b870e 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,27 @@
-Please refer to http://code.google.com/p/ibus/wiki/ReadMe .
+IBus - Input Bus
+
+Introduction
+===
+
+IBus is an Intelligent Input Bus. It is a new input framework for Linux OS.
+It provides full featured and user friendly input method user interface.
+It also may help developers to develop input method easily.
+
+
+How to build & test IBus
+===
+
+ibus-setup:
+It is a gtk program to enable and configure ibus.
+
+ibus:
+It is ibus daemon.
+
+hotkeys:
+Ctrl + Space: Enable or Disable input method
+Ctrl + Shift: Change input method.
+
+For more detail please refer to http://code.google.com/p/ibus/wiki/ReadMe .
+
+
+Peng Huang <shawn.p.huang@gmail.com>