Moved everything out of dotfiles

1 files changed, 45 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..ed5ac16
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+Janky ime for Boshiamy using only busybox commands and xdotool/termux. If ibus
+breaks you will have many backup options for using boshiamy (or any other
+ibus-table based input method)
+
+-------------------------=[Requirements for everything]=------------------------
+busybox
+	
+assume that you have the boshiamy input source file at
+	~/lang/zh/boshiamy/ibus-boshiamy/boshiamy.txt
+	from https://github.com/jdh8/ibus-boshiamy
+-----------------------------=[Different Variants]=-----------------------------
+tmux Based Input (imt)
+	requires tmux and busybox, as well as a terminal that can display
+	Chinese. Create two panes. In the second pane launch imt, it will pass
+	all input into the previously active pane, including arrow keys and
+	backspace. 
+
+	Pressing any letter will display the characters for that code, pressing
+	space or one of the number keys will select the character. pressing '`'
+	will clear the character input buffer. pressing space or 0-9 without
+	anything in the input buffer will pass that onto the previous window.
+
+	NOTE: If you put the im panel at the bottom of your tmux window you will
+	be able to access it from multiple other panels:
+
+	+--------+--------+--------+
+	|Panel 1 | Panel 2| Panel 3|
+	+--------+--------+--------+
+	|im panel                  |
+	+--------+--------+--------+
+
+tmux Based Input with Braille Display (bimt)
+	Same as above, except that it will also display the candidate characters
+	using bbrll (see https://hairydiode.xyz/cgit/bbrll). Assumes that textd
+	is in the path somewhere, as well bdf fonts in "~/lang/fonts/12"
+
+Window Manager Based Input (iml, ims)
+	requires [xdotool] and a terminal of some sort, current script uses st but
+	any terminal that can display chinese is fine.
+
+	have your window manager launch the script iml, and it will launch the
+	input method in a new terminal window and redirect the output to the
+	previously focused terminal window
+
+