From 64929e58efa786c65fac067a6c093158edd65ad7 Mon Sep 17 00:00:00 2001
From: Tom Willemse
Date: Thu, 7 May 2020 18:32:44 -0700
Subject: Add section on installing ryuk on Windows

---
 README.org | 105 +++++++++++++++++++++++++++++++++++--------------------------
 1 file changed, 60 insertions(+), 45 deletions(-)

diff --git a/README.org b/README.org
index 44552b7..73bc4a4 100644
--- a/README.org
+++ b/README.org
@@ -47,48 +47,63 @@
 
 * Installation
 
-** X11
-
-   To install and use the X11 keyboard, copy the ~xkb/ryuk~ file to where
-   XKB looks for these files. In my case this is
-   ~/usr/share/X11/xkb/symbols~. Once put in the proper place, next to,
-   for example, ~us~, set your =XkbVariant= to ~ryuk~. For example, I have in
-   my ~/etc/X11/xorg.conf.d/10-evdev.conf~ file the following:
-
-   #+BEGIN_SRC conf
-     # ...
-
-     Section "InputClass"
-         Identifier "evdev keyboard catchall"
-         MatchIsKeyboard "on"
-         MatchDevicePath "/dev/input/event*"
-         Driver "evdev"
-         Option "XkbLayout" "ryuk"
-     EndSection
-
-     # ...
-   #+END_SRC
-
-   Since your distribution may have Xorg configured differently, you
-   may have to specify it in a different file or a different section,
-   but please note that only the line starting with ~Option~ was put
-   there by me.
-
-** TTY
-
-   To install the TTY keyboard layout you should gzip the
-   ~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the
-   ~kbd~ map, and put the resulting file where the kbd utilities can find
-   them. In my case this is ~/usr/share/kbd/keymaps/i386/colemak/~, and I
-   choose the ~colemak~ directory because the ~ryuk~ files are based
-   directly off the colemak files.
-
-   Once put in the proper place you should specify that the TTY should
-   use your keymap by putting the following in your ~/etc/vconsole.conf~:
-
-   #+BEGIN_SRC sh
-     KEYMAP=ryuk
-   #+END_SRC
-
-   This should work at least on systems that use systemd. I don't know
-   how other init systems set it.
+** Linux
+
+   On Linux there's 2 ways you can install the keyboard layout. [[X11]] for the
+   graphical environment and [[TTY]] for the non-graphical environment.
+
+*** X11
+
+    To install and use the X11 keyboard, copy the ~xkb/ryuk~ file to where
+    XKB looks for these files. In my case this is
+    ~/usr/share/X11/xkb/symbols~. Once put in the proper place, next to,
+    for example, ~us~, set your =XkbVariant= to ~ryuk~. For example, I have in
+    my ~/etc/X11/xorg.conf.d/10-evdev.conf~ file the following:
+
+    #+BEGIN_SRC conf
+      # ...
+
+      Section "InputClass"
+          Identifier "evdev keyboard catchall"
+          MatchIsKeyboard "on"
+          MatchDevicePath "/dev/input/event*"
+          Driver "evdev"
+          Option "XkbLayout" "ryuk"
+      EndSection
+
+      # ...
+    #+END_SRC
+
+    Since your distribution may have Xorg configured differently, you
+    may have to specify it in a different file or a different section,
+    but please note that only the line starting with ~Option~ was put
+    there by me.
+
+*** TTY
+
+    To install the TTY keyboard layout you should gzip the
+    ~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the
+    ~kbd~ map, and put the resulting file where the kbd utilities can find
+    them. In my case this is ~/usr/share/kbd/keymaps/i386/colemak/~, and I
+    choose the ~colemak~ directory because the ~ryuk~ files are based
+    directly off the colemak files.
+
+    Once put in the proper place you should specify that the TTY should
+    use your keymap by putting the following in your ~/etc/vconsole.conf~:
+
+    #+BEGIN_SRC sh
+      KEYMAP=ryuk
+    #+END_SRC
+
+    This should work at least on systems that use systemd. I don't know
+    how other init systems set it.
+
+** Windows
+
+   On Windows you will need to install the [[https://www.microsoft.com/en-us/download/details.aspx?id=22339][Microsoft Keyboard Layout Creator 1.4]]
+   to be able to compile the keyboard layout. Once installed open the =ryuk.klc=
+   file in it and go to Project -> Build DLL and Setup Package. Once this has
+   finished it'll ask you if you want to open the directory it's built the files
+   in (which should be =%USERPROFILE%\Documents\ryuk=). Go to that directory and
+   run =setup.exe=. After the installation is finished you'll have to restart
+   Windows and then you can start using the keyboard layout.
-- 
cgit v1.2.3-54-g00ecf