Add section on installing ryuk on Windows

This commit is contained in:
Tom Willemse 2020-05-07 18:32:44 -07:00
parent 797e882b85
commit 64929e58ef

View file

@ -47,7 +47,12 @@
* Installation * Installation
** X11 ** 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 To install and use the X11 keyboard, copy the ~xkb/ryuk~ file to where
XKB looks for these files. In my case this is XKB looks for these files. In my case this is
@ -74,7 +79,7 @@
but please note that only the line starting with ~Option~ was put but please note that only the line starting with ~Option~ was put
there by me. there by me.
** TTY *** TTY
To install the TTY keyboard layout you should gzip the To install the TTY keyboard layout you should gzip the
~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the ~kbd/ryuk.map~ file, which can be achieved by running ~make~ from the
@ -92,3 +97,13 @@
This should work at least on systems that use systemd. I don't know This should work at least on systems that use systemd. I don't know
how other init systems set it. 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.