From e0bfebee1f07484eca9acf092ea16c1552344e95 Mon Sep 17 00:00:00 2001
From: Chuang Zhu <git@chuang.cz>
Date: Fri, 9 Jun 2023 18:16:40 +0800
Subject: [PATCH] add notes on ime

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 225fd96..5ee0657 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,32 @@ A Nixpkgs overlay providing patches, and a NixOS module providing useful configu
 
 For using with Nixpkgs, add `./overlay.nix` or `nixpkgs-gnome-mobile.overlays.default` to your Nixpkgs overlays. For using with NixOS, add `./module.nix` to your `imports` in `configuration.nix`, or `nixpkgs-gnome-mobile.nixosModules.gnome-mobile` to your `modules` in `nixpkgs.lib.nixosSystem`.
 
-## Debugging gnome-shell
+This overlay targets the `nixos-unstable` channel. Please let me know if anything breaks on the latest `nixos-unstable`.
+
+## FAQ
+
+### Do input methods work?
+
+Yes, only IBus works. You have to be careful not to set the `*_IM_MODULE` env vars (done in `./module.nix`), or the keyboard won't pop up. Example NixOS configuration:
+
+```nix
+i18n.inputMethod.enabled = "ibus";
+i18n.inputMethod.ibus.engines = with pkgs.ibus-engines; [ libpinyin anthy ];
+```
+
+Add input methods in Settings > Keyboard, or with the following command:
+
+```shellsession
+$ dconf write /org/gnome/desktop/input-sources/sources "[('xkb', 'us'), ('ibus', 'libpinyin'), ('ibus', 'anthy')]"
+```
+
+For the Japanese IME anthy, you may also want to change the input mode from Latin to Kana:
+
+```shellsession
+$ dconf write /org/freedesktop/ibus/engine/anthy/common/input-mode 0 # Hiragana
+```
+
+### Debugging gnome-shell
 
 The Wayland compositor can be started directly from the Linux console. The log is actually verbose enough to identify problems, but for unknown reasons you may have to redirect the stderr to see it: