add resources and documentation

Author: skurzinz

README.md

@@ -1,2 +1,49 @@
 # ota-keyboard
 Repo for a Windows input method for ottoman turkish ota-TR keyboard for the QHOD project, created in MS Keyboard Layout Creator
+
+## About
+
+Keyboard created for the transcription of Ottoman sources using the IJMES transcription tables for Windows.
+
+Behaviour is derived from the standard tr-TR QWERTY Turkish keyboard.
+
+![MSKLC screenshot of IJMES Keyboard](ijmes.png "Screenshot")
+
+In the Alt-Gr/Alt-Cmd/Right-Alt shift state, we add *dead keys*: 
+
+- <kbd>Alt-Gr</kbd> + <kbd>,</kbd>: Combining dot below (works with HhKkSsTtZz) 
+- <kbd>Alt-Gr</kbd> + <kbd>.</kbd>: Combining dot above (works with HhSsTtZz) 
+- <kbd>Alt-Gr</kbd> + <kbd>-</kbd>: Combining macron below (works with NnZz). **Note**: As MSKLC is not able to create combined characters that do not have a single codepoint in Unicode, S̠s̠ has to be typed as <kbd>S</kbd> + <kbd>Alt-Gr</kbd> + <kbd>-</kbd> + <kbd>space</kbd>
+
+## Coverage
+
+The keyboard includes the following special characters. 
+
+ʾʿ  
+ḢḣḤḥ  
+Ḳḳ  
+̠Nn̠  
+ṠṡṢṣ̠Ss̠
+ṪṫṬṭ  
+ŻżẒẓ̠Z̠z̠  
+
+
+## Installation
+
+1. Use the provided windows installer files.
+2. In Windows Settings, add Turkish as a Language. 
+3. Select Turkish/Türkce Language > Options and add Keyboard from the list
+4. Type ahead. 
+
+
+## Customization 
+
+Using MS Keyboard Layout Creator: 
+
+1. Get MSKLC.exe from the interwebs.
+2. Try if it works
+    a. You're fine.
+    b. You have to install the ancient .NET 2.0 framework. [Useful info on how to do this](https://www.windows-faq.de/2016/10/30/net-framework-2-0-und-3-5-unter-windows-10-installieren/) (in German)
+3. Open the `ijmes.klc` file and change it until it suits your needs. 
+4. Recompile the `.dll` (likely you will have to uninstall the previous version to avoid naming clash)
+