From 13914826a29a33663c63a1563332db0336855359 Mon Sep 17 00:00:00 2001
From: Lzu Tao <taolzu@gmail.com>
Date: Sat, 7 Sep 2024 01:26:20 +0700
Subject: [PATCH] add dumb readme

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 todo      | 34 ----------------------------------
 2 files changed, 36 insertions(+), 34 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e869248
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# ibus-gokien - Vietnamese input method engine for IBus
+
+## Install and test with log
+
+```bash
+ibus read-config
+env DCONF_PROFILE=ibus dconf read /desktop/ibus/general/preload-engines
+ibus-setup
+gsettings get org.gnome.desktop.input-sources sources
+```
+
+Standalone:
+```
+just run debug
+ibus engine gokien
+```
+
+## Known bugs
+
+N/A.
+
+### Unsupported/Hard features
+
+* surrounding_text: sometimes work in firefox textbox
+
+* emulate fake backspace: `ibus_engine_forward_key_event`
+  won't implement. IBus is too buggy and warn people about this.
+
+  https://github.com/BoGoEngine/ibus-bogo/issues/216
+
+* Fcitx https://github.com/fcitx/fcitx5-unikey
+  + too MUCH c++. no c api. Rust can use cxx crate but no thanks.
+  + https://fcitx-im.org/wiki/Develop_an_simple_input_method
+  + https://codedocs.xyz/fcitx/fcitx5/group__FcitxCore.html
+  + apt download fcitx-core-dev
+  + can view source of fcitx5-bamboo and fcitx-unikey for API usage
diff --git a/todo b/todo
index 2515dc9..58b39b8 100644
--- a/todo
+++ b/todo
@@ -3,37 +3,3 @@
 # reuse vi@0.7 for vncharset
 
 # rewrite vi::Word with char?
-
-### Install and test with log
-  ```bash
-  ibus read-config
-  env DCONF_PROFILE=ibus dconf read /desktop/ibus/general/preload-engines
-  ibus-setup
-  gsettings get org.gnome.desktop.input-sources sources
-  ```
-
-  Standalone:
-  ```
-  just run debug
-  ibus engine gokien
-  ```
-
-### Known bugs
-
-### hard features
-
-* surrounding_text: sometimes work in firefox textbox
-
-* emulate fake backspace: ibus_engine_forward_key_event
-  won't implement. too lazy and too much pain for that
-
-  https://github.com/BoGoEngine/ibus-bogo/issues/216
-
-#### Fcitx
-
-* Fcitx https://github.com/fcitx/fcitx5-unikey
-  + too MUCH c++. no c api. Rust can use cxx crate but no thanks.
-  + https://fcitx-im.org/wiki/Develop_an_simple_input_method
-  + https://codedocs.xyz/fcitx/fcitx5/group__FcitxCore.html
-  + apt download fcitx-core-dev
-  + can view source of fcitx5-bamboo and fcitx-unikey for API usage